mirror of
				https://github.com/esphome/esphome.git
				synced 2025-11-04 00:51:49 +00:00 
			
		
		
		
	Compare commits
	
		
			1 Commits
		
	
	
		
			2025.2.2
			...
			power-supp
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| 
						 | 
					49eba0a9bc | 
							
								
								
									
										36
									
								
								.clang-tidy
									
									
									
									
									
								
							
							
						
						
									
										36
									
								
								.clang-tidy
									
									
									
									
									
								
							@@ -7,39 +7,28 @@ Checks: >-
 | 
			
		||||
  -boost-*,
 | 
			
		||||
  -bugprone-easily-swappable-parameters,
 | 
			
		||||
  -bugprone-implicit-widening-of-multiplication-result,
 | 
			
		||||
  -bugprone-multi-level-implicit-pointer-conversion,
 | 
			
		||||
  -bugprone-narrowing-conversions,
 | 
			
		||||
  -bugprone-signed-char-misuse,
 | 
			
		||||
  -bugprone-switch-missing-default-case,
 | 
			
		||||
  -cert-dcl50-cpp,
 | 
			
		||||
  -cert-err33-c,
 | 
			
		||||
  -cert-err58-cpp,
 | 
			
		||||
  -cert-oop57-cpp,
 | 
			
		||||
  -cert-str34-c,
 | 
			
		||||
  -clang-analyzer-optin.core.EnumCastOutOfRange,
 | 
			
		||||
  -clang-analyzer-optin.cplusplus.UninitializedObject,
 | 
			
		||||
  -clang-analyzer-osx.*,
 | 
			
		||||
  -clang-diagnostic-delete-abstract-non-virtual-dtor,
 | 
			
		||||
  -clang-diagnostic-delete-non-abstract-non-virtual-dtor,
 | 
			
		||||
  -clang-diagnostic-deprecated-declarations,
 | 
			
		||||
  -clang-diagnostic-ignored-optimization-argument,
 | 
			
		||||
  -clang-diagnostic-missing-field-initializers,
 | 
			
		||||
  -clang-diagnostic-shadow-field,
 | 
			
		||||
  -clang-diagnostic-unused-const-variable,
 | 
			
		||||
  -clang-diagnostic-unused-parameter,
 | 
			
		||||
  -clang-diagnostic-vla-cxx-extension,
 | 
			
		||||
  -concurrency-*,
 | 
			
		||||
  -cppcoreguidelines-avoid-c-arrays,
 | 
			
		||||
  -cppcoreguidelines-avoid-const-or-ref-data-members,
 | 
			
		||||
  -cppcoreguidelines-avoid-do-while,
 | 
			
		||||
  -cppcoreguidelines-avoid-magic-numbers,
 | 
			
		||||
  -cppcoreguidelines-init-variables,
 | 
			
		||||
  -cppcoreguidelines-macro-to-enum,
 | 
			
		||||
  -cppcoreguidelines-macro-usage,
 | 
			
		||||
  -cppcoreguidelines-missing-std-forward,
 | 
			
		||||
  -cppcoreguidelines-narrowing-conversions,
 | 
			
		||||
  -cppcoreguidelines-non-private-member-variables-in-classes,
 | 
			
		||||
  -cppcoreguidelines-owning-memory,
 | 
			
		||||
  -cppcoreguidelines-prefer-member-initializer,
 | 
			
		||||
  -cppcoreguidelines-pro-bounds-array-to-pointer-decay,
 | 
			
		||||
  -cppcoreguidelines-pro-bounds-constant-array-index,
 | 
			
		||||
@@ -51,9 +40,7 @@ Checks: >-
 | 
			
		||||
  -cppcoreguidelines-pro-type-static-cast-downcast,
 | 
			
		||||
  -cppcoreguidelines-pro-type-union-access,
 | 
			
		||||
  -cppcoreguidelines-pro-type-vararg,
 | 
			
		||||
  -cppcoreguidelines-rvalue-reference-param-not-moved,
 | 
			
		||||
  -cppcoreguidelines-special-member-functions,
 | 
			
		||||
  -cppcoreguidelines-use-default-member-init,
 | 
			
		||||
  -cppcoreguidelines-virtual-class-destructor,
 | 
			
		||||
  -fuchsia-multiple-inheritance,
 | 
			
		||||
  -fuchsia-overloaded-operator,
 | 
			
		||||
@@ -73,32 +60,20 @@ Checks: >-
 | 
			
		||||
  -llvm-include-order,
 | 
			
		||||
  -llvm-qualified-auto,
 | 
			
		||||
  -llvmlibc-*,
 | 
			
		||||
  -misc-const-correctness,
 | 
			
		||||
  -misc-include-cleaner,
 | 
			
		||||
  -misc-no-recursion,
 | 
			
		||||
  -misc-non-private-member-variables-in-classes,
 | 
			
		||||
  -misc-no-recursion,
 | 
			
		||||
  -misc-unused-parameters,
 | 
			
		||||
  -misc-use-anonymous-namespace,
 | 
			
		||||
  -modernize-avoid-bind,
 | 
			
		||||
  -modernize-avoid-c-arrays,
 | 
			
		||||
  -modernize-avoid-bind,
 | 
			
		||||
  -modernize-concat-nested-namespaces,
 | 
			
		||||
  -modernize-macro-to-enum,
 | 
			
		||||
  -modernize-return-braced-init-list,
 | 
			
		||||
  -modernize-type-traits,
 | 
			
		||||
  -modernize-use-auto,
 | 
			
		||||
  -modernize-use-constraints,
 | 
			
		||||
  -modernize-use-default-member-init,
 | 
			
		||||
  -modernize-use-equals-default,
 | 
			
		||||
  -modernize-use-nodiscard,
 | 
			
		||||
  -modernize-use-nullptr,
 | 
			
		||||
  -modernize-use-nodiscard,
 | 
			
		||||
  -modernize-use-nullptr,
 | 
			
		||||
  -modernize-use-trailing-return-type,
 | 
			
		||||
  -modernize-use-nodiscard,
 | 
			
		||||
  -mpi-*,
 | 
			
		||||
  -objc-*,
 | 
			
		||||
  -performance-enum-size,
 | 
			
		||||
  -readability-avoid-nested-conditional-operator,
 | 
			
		||||
  -readability-container-contains,
 | 
			
		||||
  -readability-container-data-pointer,
 | 
			
		||||
  -readability-convert-member-functions-to-static,
 | 
			
		||||
  -readability-else-after-return,
 | 
			
		||||
@@ -107,14 +82,11 @@ Checks: >-
 | 
			
		||||
  -readability-isolate-declaration,
 | 
			
		||||
  -readability-magic-numbers,
 | 
			
		||||
  -readability-make-member-function-const,
 | 
			
		||||
  -readability-named-parameter,
 | 
			
		||||
  -readability-redundant-casting,
 | 
			
		||||
  -readability-redundant-inline-specifier,
 | 
			
		||||
  -readability-redundant-member-init,
 | 
			
		||||
  -readability-redundant-string-init,
 | 
			
		||||
  -readability-uppercase-literal-suffix,
 | 
			
		||||
  -readability-use-anyofallof,
 | 
			
		||||
WarningsAsErrors: '*'
 | 
			
		||||
AnalyzeTemporaryDtors: false
 | 
			
		||||
FormatStyle:     google
 | 
			
		||||
CheckOptions:
 | 
			
		||||
  - key:             google-readability-function-size.StatementThreshold
 | 
			
		||||
 
 | 
			
		||||
@@ -75,9 +75,6 @@ target/
 | 
			
		||||
# pyenv
 | 
			
		||||
.python-version
 | 
			
		||||
 | 
			
		||||
# asdf
 | 
			
		||||
.tool-versions
 | 
			
		||||
 | 
			
		||||
# celery beat schedule file
 | 
			
		||||
celerybeat-schedule
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										15
									
								
								.github/PULL_REQUEST_TEMPLATE.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										15
									
								
								.github/PULL_REQUEST_TEMPLATE.md
									
									
									
									
										vendored
									
									
								
							@@ -7,16 +7,11 @@
 | 
			
		||||
- [ ] 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):**
 | 
			
		||||
**Related issue or feature (if applicable):** fixes <link to issue>
 | 
			
		||||
 | 
			
		||||
- fixes <link to issue>
 | 
			
		||||
 | 
			
		||||
**Pull request in [esphome-docs](https://github.com/esphome/esphome-docs) with documentation (if applicable):**
 | 
			
		||||
 | 
			
		||||
- esphome/esphome-docs#<esphome-docs PR number goes here>
 | 
			
		||||
**Pull request in [esphome-docs](https://github.com/esphome/esphome-docs) with documentation (if applicable):** esphome/esphome-docs#<esphome-docs PR number goes here>
 | 
			
		||||
 | 
			
		||||
## Test Environment
 | 
			
		||||
 | 
			
		||||
@@ -28,6 +23,12 @@
 | 
			
		||||
- [ ] RTL87xx
 | 
			
		||||
 | 
			
		||||
## Example entry for `config.yaml`:
 | 
			
		||||
<!--
 | 
			
		||||
  Supplying a configuration snippet, makes it easier for a maintainer to test
 | 
			
		||||
  your PR. Furthermore, for new integrations, it gives an impression of how
 | 
			
		||||
  the configuration would look like.
 | 
			
		||||
  Note: Remove this section if this PR does not have an example entry.
 | 
			
		||||
-->
 | 
			
		||||
 | 
			
		||||
```yaml
 | 
			
		||||
# Example config.yaml
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										10
									
								
								.github/actions/build-image/action.yaml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										10
									
								
								.github/actions/build-image/action.yaml
									
									
									
									
										vendored
									
									
								
							@@ -46,10 +46,7 @@ runs:
 | 
			
		||||
 | 
			
		||||
    - name: Build and push to ghcr by digest
 | 
			
		||||
      id: build-ghcr
 | 
			
		||||
      uses: docker/build-push-action@v6.13.0
 | 
			
		||||
      env:
 | 
			
		||||
        DOCKER_BUILD_SUMMARY: false
 | 
			
		||||
        DOCKER_BUILD_RECORD_UPLOAD: false
 | 
			
		||||
      uses: docker/build-push-action@v6.7.0
 | 
			
		||||
      with:
 | 
			
		||||
        context: .
 | 
			
		||||
        file: ./docker/Dockerfile
 | 
			
		||||
@@ -72,10 +69,7 @@ runs:
 | 
			
		||||
 | 
			
		||||
    - name: Build and push to dockerhub by digest
 | 
			
		||||
      id: build-dockerhub
 | 
			
		||||
      uses: docker/build-push-action@v6.13.0
 | 
			
		||||
      env:
 | 
			
		||||
        DOCKER_BUILD_SUMMARY: false
 | 
			
		||||
        DOCKER_BUILD_RECORD_UPLOAD: false
 | 
			
		||||
      uses: docker/build-push-action@v6.7.0
 | 
			
		||||
      with:
 | 
			
		||||
        context: .
 | 
			
		||||
        file: ./docker/Dockerfile
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										4
									
								
								.github/actions/restore-python/action.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										4
									
								
								.github/actions/restore-python/action.yml
									
									
									
									
										vendored
									
									
								
							@@ -17,12 +17,12 @@ runs:
 | 
			
		||||
  steps:
 | 
			
		||||
    - name: Set up Python ${{ inputs.python-version }}
 | 
			
		||||
      id: python
 | 
			
		||||
      uses: actions/setup-python@v5.4.0
 | 
			
		||||
      uses: actions/setup-python@v5.1.1
 | 
			
		||||
      with:
 | 
			
		||||
        python-version: ${{ inputs.python-version }}
 | 
			
		||||
    - name: Restore Python virtual environment
 | 
			
		||||
      id: cache-venv
 | 
			
		||||
      uses: actions/cache/restore@v4.2.0
 | 
			
		||||
      uses: actions/cache/restore@v4.0.2
 | 
			
		||||
      with:
 | 
			
		||||
        path: venv
 | 
			
		||||
        # yamllint disable-line rule:line-length
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										2
									
								
								.github/workflows/ci-api-proto.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										2
									
								
								.github/workflows/ci-api-proto.yml
									
									
									
									
										vendored
									
									
								
							@@ -23,7 +23,7 @@ jobs:
 | 
			
		||||
      - name: Checkout
 | 
			
		||||
        uses: actions/checkout@v4.1.7
 | 
			
		||||
      - name: Set up Python
 | 
			
		||||
        uses: actions/setup-python@v5.4.0
 | 
			
		||||
        uses: actions/setup-python@v5.1.0
 | 
			
		||||
        with:
 | 
			
		||||
          python-version: "3.11"
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										8
									
								
								.github/workflows/ci-docker.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										8
									
								
								.github/workflows/ci-docker.yml
									
									
									
									
										vendored
									
									
								
							@@ -37,18 +37,18 @@ jobs:
 | 
			
		||||
    strategy:
 | 
			
		||||
      fail-fast: false
 | 
			
		||||
      matrix:
 | 
			
		||||
        arch: [amd64, aarch64]
 | 
			
		||||
        arch: [amd64, armv7, aarch64]
 | 
			
		||||
        build_type: ["ha-addon", "docker", "lint"]
 | 
			
		||||
    steps:
 | 
			
		||||
      - uses: actions/checkout@v4.1.7
 | 
			
		||||
      - name: Set up Python
 | 
			
		||||
        uses: actions/setup-python@v5.4.0
 | 
			
		||||
        uses: actions/setup-python@v5.1.0
 | 
			
		||||
        with:
 | 
			
		||||
          python-version: "3.9"
 | 
			
		||||
      - name: Set up Docker Buildx
 | 
			
		||||
        uses: docker/setup-buildx-action@v3.9.0
 | 
			
		||||
        uses: docker/setup-buildx-action@v3.6.1
 | 
			
		||||
      - name: Set up QEMU
 | 
			
		||||
        uses: docker/setup-qemu-action@v3.4.0
 | 
			
		||||
        uses: docker/setup-qemu-action@v3.2.0
 | 
			
		||||
 | 
			
		||||
      - name: Set TAG
 | 
			
		||||
        run: |
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										48
									
								
								.github/workflows/ci.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										48
									
								
								.github/workflows/ci.yml
									
									
									
									
										vendored
									
									
								
							@@ -13,7 +13,6 @@ on:
 | 
			
		||||
      - ".github/workflows/ci.yml"
 | 
			
		||||
      - "!.yamllint"
 | 
			
		||||
      - "!.github/dependabot.yml"
 | 
			
		||||
      - "!docker/**"
 | 
			
		||||
  merge_group:
 | 
			
		||||
 | 
			
		||||
permissions:
 | 
			
		||||
@@ -31,7 +30,7 @@ concurrency:
 | 
			
		||||
jobs:
 | 
			
		||||
  common:
 | 
			
		||||
    name: Create common environment
 | 
			
		||||
    runs-on: ubuntu-24.04
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    outputs:
 | 
			
		||||
      cache-key: ${{ steps.cache-key.outputs.key }}
 | 
			
		||||
    steps:
 | 
			
		||||
@@ -42,12 +41,12 @@ jobs:
 | 
			
		||||
        run: echo key="${{ hashFiles('requirements.txt', 'requirements_optional.txt', 'requirements_test.txt') }}" >> $GITHUB_OUTPUT
 | 
			
		||||
      - name: Set up Python ${{ env.DEFAULT_PYTHON }}
 | 
			
		||||
        id: python
 | 
			
		||||
        uses: actions/setup-python@v5.4.0
 | 
			
		||||
        uses: actions/setup-python@v5.1.0
 | 
			
		||||
        with:
 | 
			
		||||
          python-version: ${{ env.DEFAULT_PYTHON }}
 | 
			
		||||
      - name: Restore Python virtual environment
 | 
			
		||||
        id: cache-venv
 | 
			
		||||
        uses: actions/cache@v4.2.0
 | 
			
		||||
        uses: actions/cache@v4.0.2
 | 
			
		||||
        with:
 | 
			
		||||
          path: venv
 | 
			
		||||
          # yamllint disable-line rule:line-length
 | 
			
		||||
@@ -63,7 +62,7 @@ jobs:
 | 
			
		||||
 | 
			
		||||
  black:
 | 
			
		||||
    name: Check black
 | 
			
		||||
    runs-on: ubuntu-24.04
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    needs:
 | 
			
		||||
      - common
 | 
			
		||||
    steps:
 | 
			
		||||
@@ -84,7 +83,7 @@ jobs:
 | 
			
		||||
 | 
			
		||||
  flake8:
 | 
			
		||||
    name: Check flake8
 | 
			
		||||
    runs-on: ubuntu-24.04
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    needs:
 | 
			
		||||
      - common
 | 
			
		||||
    steps:
 | 
			
		||||
@@ -105,7 +104,7 @@ jobs:
 | 
			
		||||
 | 
			
		||||
  pylint:
 | 
			
		||||
    name: Check pylint
 | 
			
		||||
    runs-on: ubuntu-24.04
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    needs:
 | 
			
		||||
      - common
 | 
			
		||||
    steps:
 | 
			
		||||
@@ -126,7 +125,7 @@ jobs:
 | 
			
		||||
 | 
			
		||||
  pyupgrade:
 | 
			
		||||
    name: Check pyupgrade
 | 
			
		||||
    runs-on: ubuntu-24.04
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    needs:
 | 
			
		||||
      - common
 | 
			
		||||
    steps:
 | 
			
		||||
@@ -147,7 +146,7 @@ jobs:
 | 
			
		||||
 | 
			
		||||
  ci-custom:
 | 
			
		||||
    name: Run script/ci-custom
 | 
			
		||||
    runs-on: ubuntu-24.04
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    needs:
 | 
			
		||||
      - common
 | 
			
		||||
    steps:
 | 
			
		||||
@@ -220,13 +219,13 @@ jobs:
 | 
			
		||||
          . venv/bin/activate
 | 
			
		||||
          pytest -vv --cov-report=xml --tb=native tests
 | 
			
		||||
      - name: Upload coverage to Codecov
 | 
			
		||||
        uses: codecov/codecov-action@v5
 | 
			
		||||
        uses: codecov/codecov-action@v4
 | 
			
		||||
        with:
 | 
			
		||||
          token: ${{ secrets.CODECOV_TOKEN }}
 | 
			
		||||
 | 
			
		||||
  clang-format:
 | 
			
		||||
    name: Check clang-format
 | 
			
		||||
    runs-on: ubuntu-24.04
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    needs:
 | 
			
		||||
      - common
 | 
			
		||||
    steps:
 | 
			
		||||
@@ -252,7 +251,7 @@ jobs:
 | 
			
		||||
 | 
			
		||||
  clang-tidy:
 | 
			
		||||
    name: ${{ matrix.name }}
 | 
			
		||||
    runs-on: ubuntu-24.04
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    needs:
 | 
			
		||||
      - common
 | 
			
		||||
      - black
 | 
			
		||||
@@ -303,18 +302,21 @@ jobs:
 | 
			
		||||
 | 
			
		||||
      - name: Cache platformio
 | 
			
		||||
        if: github.ref == 'refs/heads/dev'
 | 
			
		||||
        uses: actions/cache@v4.2.0
 | 
			
		||||
        uses: actions/cache@v4.0.2
 | 
			
		||||
        with:
 | 
			
		||||
          path: ~/.platformio
 | 
			
		||||
          key: platformio-${{ matrix.pio_cache_key }}
 | 
			
		||||
 | 
			
		||||
      - name: Cache platformio
 | 
			
		||||
        if: github.ref != 'refs/heads/dev'
 | 
			
		||||
        uses: actions/cache/restore@v4.2.0
 | 
			
		||||
        uses: actions/cache/restore@v4.0.2
 | 
			
		||||
        with:
 | 
			
		||||
          path: ~/.platformio
 | 
			
		||||
          key: platformio-${{ matrix.pio_cache_key }}
 | 
			
		||||
 | 
			
		||||
      - name: Install clang-tidy
 | 
			
		||||
        run: sudo apt-get install clang-tidy-14
 | 
			
		||||
 | 
			
		||||
      - name: Register problem matchers
 | 
			
		||||
        run: |
 | 
			
		||||
          echo "::add-matcher::.github/workflows/matchers/gcc.json"
 | 
			
		||||
@@ -341,7 +343,7 @@ jobs:
 | 
			
		||||
        if: always()
 | 
			
		||||
 | 
			
		||||
  list-components:
 | 
			
		||||
    runs-on: ubuntu-24.04
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    needs:
 | 
			
		||||
      - common
 | 
			
		||||
    if: github.event_name == 'pull_request'
 | 
			
		||||
@@ -383,7 +385,7 @@ jobs:
 | 
			
		||||
 | 
			
		||||
  test-build-components:
 | 
			
		||||
    name: Component test ${{ matrix.file }}
 | 
			
		||||
    runs-on: ubuntu-24.04
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    needs:
 | 
			
		||||
      - common
 | 
			
		||||
      - list-components
 | 
			
		||||
@@ -395,9 +397,7 @@ jobs:
 | 
			
		||||
        file: ${{ fromJson(needs.list-components.outputs.components) }}
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: Install dependencies
 | 
			
		||||
        run: |
 | 
			
		||||
          sudo apt-get update
 | 
			
		||||
          sudo apt-get install libsdl2-dev
 | 
			
		||||
        run: sudo apt-get install libsdl2-dev
 | 
			
		||||
 | 
			
		||||
      - name: Check out code from GitHub
 | 
			
		||||
        uses: actions/checkout@v4.1.7
 | 
			
		||||
@@ -417,7 +417,7 @@ jobs:
 | 
			
		||||
 | 
			
		||||
  test-build-components-splitter:
 | 
			
		||||
    name: Split components for testing into 20 groups maximum
 | 
			
		||||
    runs-on: ubuntu-24.04
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    needs:
 | 
			
		||||
      - common
 | 
			
		||||
      - list-components
 | 
			
		||||
@@ -435,7 +435,7 @@ jobs:
 | 
			
		||||
 | 
			
		||||
  test-build-components-split:
 | 
			
		||||
    name: Test split components
 | 
			
		||||
    runs-on: ubuntu-24.04
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    needs:
 | 
			
		||||
      - common
 | 
			
		||||
      - list-components
 | 
			
		||||
@@ -451,9 +451,7 @@ jobs:
 | 
			
		||||
        run: echo ${{ matrix.components }}
 | 
			
		||||
 | 
			
		||||
      - name: Install dependencies
 | 
			
		||||
        run: |
 | 
			
		||||
          sudo apt-get update
 | 
			
		||||
          sudo apt-get install libsdl2-dev
 | 
			
		||||
        run: sudo apt-get install libsdl2-dev
 | 
			
		||||
 | 
			
		||||
      - name: Check out code from GitHub
 | 
			
		||||
        uses: actions/checkout@v4.1.7
 | 
			
		||||
@@ -479,7 +477,7 @@ jobs:
 | 
			
		||||
 | 
			
		||||
  ci-status:
 | 
			
		||||
    name: CI Status
 | 
			
		||||
    runs-on: ubuntu-24.04
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    needs:
 | 
			
		||||
      - common
 | 
			
		||||
      - black
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										91
									
								
								.github/workflows/codeql.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										91
									
								
								.github/workflows/codeql.yml
									
									
									
									
										vendored
									
									
								
							@@ -1,91 +0,0 @@
 | 
			
		||||
# 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}}"
 | 
			
		||||
							
								
								
									
										15
									
								
								.github/workflows/release.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										15
									
								
								.github/workflows/release.yml
									
									
									
									
										vendored
									
									
								
							@@ -53,7 +53,7 @@ jobs:
 | 
			
		||||
    steps:
 | 
			
		||||
      - uses: actions/checkout@v4.1.7
 | 
			
		||||
      - name: Set up Python
 | 
			
		||||
        uses: actions/setup-python@v5.4.0
 | 
			
		||||
        uses: actions/setup-python@v5.1.0
 | 
			
		||||
        with:
 | 
			
		||||
          python-version: "3.x"
 | 
			
		||||
      - name: Set up python environment
 | 
			
		||||
@@ -65,7 +65,7 @@ jobs:
 | 
			
		||||
          pip3 install build
 | 
			
		||||
          python3 -m build
 | 
			
		||||
      - name: Publish
 | 
			
		||||
        uses: pypa/gh-action-pypi-publish@v1.12.4
 | 
			
		||||
        uses: pypa/gh-action-pypi-publish@v1.9.0
 | 
			
		||||
 | 
			
		||||
  deploy-docker:
 | 
			
		||||
    name: Build ESPHome ${{ matrix.platform }}
 | 
			
		||||
@@ -80,19 +80,20 @@ jobs:
 | 
			
		||||
      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.4.0
 | 
			
		||||
        uses: actions/setup-python@v5.1.0
 | 
			
		||||
        with:
 | 
			
		||||
          python-version: "3.9"
 | 
			
		||||
 | 
			
		||||
      - name: Set up Docker Buildx
 | 
			
		||||
        uses: docker/setup-buildx-action@v3.9.0
 | 
			
		||||
        uses: docker/setup-buildx-action@v3.6.1
 | 
			
		||||
      - name: Set up QEMU
 | 
			
		||||
        if: matrix.platform != 'linux/amd64'
 | 
			
		||||
        uses: docker/setup-qemu-action@v3.4.0
 | 
			
		||||
        uses: docker/setup-qemu-action@v3.2.0
 | 
			
		||||
 | 
			
		||||
      - name: Log in to docker hub
 | 
			
		||||
        uses: docker/login-action@v3.3.0
 | 
			
		||||
@@ -140,7 +141,7 @@ jobs:
 | 
			
		||||
          echo name=$(cat /tmp/platform) >> $GITHUB_OUTPUT
 | 
			
		||||
 | 
			
		||||
      - name: Upload digests
 | 
			
		||||
        uses: actions/upload-artifact@v4.6.0
 | 
			
		||||
        uses: actions/upload-artifact@v4.3.4
 | 
			
		||||
        with:
 | 
			
		||||
          name: digests-${{ steps.sanitize.outputs.name }}
 | 
			
		||||
          path: /tmp/digests
 | 
			
		||||
@@ -183,7 +184,7 @@ jobs:
 | 
			
		||||
          merge-multiple: true
 | 
			
		||||
 | 
			
		||||
      - name: Set up Docker Buildx
 | 
			
		||||
        uses: docker/setup-buildx-action@v3.9.0
 | 
			
		||||
        uses: docker/setup-buildx-action@v3.6.1
 | 
			
		||||
 | 
			
		||||
      - name: Log in to docker hub
 | 
			
		||||
        if: matrix.registry == 'dockerhub'
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										4
									
								
								.github/workflows/stale.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										4
									
								
								.github/workflows/stale.yml
									
									
									
									
										vendored
									
									
								
							@@ -17,7 +17,7 @@ jobs:
 | 
			
		||||
  stale:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
      - uses: actions/stale@v9.1.0
 | 
			
		||||
      - uses: actions/stale@v9.0.0
 | 
			
		||||
        with:
 | 
			
		||||
          days-before-pr-stale: 90
 | 
			
		||||
          days-before-pr-close: 7
 | 
			
		||||
@@ -37,7 +37,7 @@ jobs:
 | 
			
		||||
  close-issues:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
      - uses: actions/stale@v9.1.0
 | 
			
		||||
      - uses: actions/stale@v9.0.0
 | 
			
		||||
        with:
 | 
			
		||||
          days-before-pr-stale: -1
 | 
			
		||||
          days-before-pr-close: -1
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										4
									
								
								.github/workflows/sync-device-classes.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										4
									
								
								.github/workflows/sync-device-classes.yml
									
									
									
									
										vendored
									
									
								
							@@ -22,7 +22,7 @@ jobs:
 | 
			
		||||
          path: lib/home-assistant
 | 
			
		||||
 | 
			
		||||
      - name: Setup Python
 | 
			
		||||
        uses: actions/setup-python@v5.4.0
 | 
			
		||||
        uses: actions/setup-python@v5.1.0
 | 
			
		||||
        with:
 | 
			
		||||
          python-version: 3.12
 | 
			
		||||
 | 
			
		||||
@@ -36,7 +36,7 @@ jobs:
 | 
			
		||||
          python ./script/sync-device_class.py
 | 
			
		||||
 | 
			
		||||
      - name: Commit changes
 | 
			
		||||
        uses: peter-evans/create-pull-request@v7.0.6
 | 
			
		||||
        uses: peter-evans/create-pull-request@v6.1.0
 | 
			
		||||
        with:
 | 
			
		||||
          commit-message: "Synchronise Device Classes from Home Assistant"
 | 
			
		||||
          committer: esphomebot <esphome@nabucasa.com>
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										3
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										3
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							@@ -75,9 +75,6 @@ cov.xml
 | 
			
		||||
# pyenv
 | 
			
		||||
.python-version
 | 
			
		||||
 | 
			
		||||
# asdf
 | 
			
		||||
.tool-versions
 | 
			
		||||
 | 
			
		||||
# Environments
 | 
			
		||||
.env
 | 
			
		||||
.venv
 | 
			
		||||
 
 | 
			
		||||
@@ -11,6 +11,14 @@ repos:
 | 
			
		||||
        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:
 | 
			
		||||
          - --safe
 | 
			
		||||
          - --quiet
 | 
			
		||||
        files: ^((esphome|script|tests)/.+)?[^/]+\.py$
 | 
			
		||||
  - repo: https://github.com/PyCQA/flake8
 | 
			
		||||
    rev: 6.1.0
 | 
			
		||||
    hooks:
 | 
			
		||||
@@ -45,6 +53,6 @@ repos:
 | 
			
		||||
    hooks:
 | 
			
		||||
      - id: pylint
 | 
			
		||||
        name: pylint
 | 
			
		||||
        entry: python3 script/run-in-env.py pylint
 | 
			
		||||
        language: system
 | 
			
		||||
        entry: script/run-in-env.sh pylint
 | 
			
		||||
        language: script
 | 
			
		||||
        types: [python]
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										52
									
								
								CODEOWNERS
									
									
									
									
									
								
							
							
						
						
									
										52
									
								
								CODEOWNERS
									
									
									
									
									
								
							@@ -24,7 +24,6 @@ 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
 | 
			
		||||
@@ -48,10 +47,6 @@ 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_adc/* @kbx81
 | 
			
		||||
esphome/components/audio_dac/* @kbx81
 | 
			
		||||
esphome/components/axs15231/* @clydebarrow
 | 
			
		||||
esphome/components/b_parasite/* @rbaron
 | 
			
		||||
esphome/components/ballu/* @bazuchan
 | 
			
		||||
esphome/components/bang_bang/* @OttoWinter
 | 
			
		||||
@@ -63,10 +58,9 @@ 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 @dwmw2
 | 
			
		||||
esphome/components/bl0942/* @dbuezas
 | 
			
		||||
esphome/components/ble_client/* @buxtronix @clydebarrow
 | 
			
		||||
esphome/components/bluetooth_proxy/* @jesserockz
 | 
			
		||||
esphome/components/bme280_base/* @esphome/core
 | 
			
		||||
@@ -75,9 +69,6 @@ esphome/components/bme680_bsec/* @trvrnrth
 | 
			
		||||
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
 | 
			
		||||
@@ -86,13 +77,11 @@ 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/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
 | 
			
		||||
@@ -132,10 +121,6 @@ esphome/components/ens160_base/* @latonita @vincentscode
 | 
			
		||||
esphome/components/ens160_i2c/* @latonita
 | 
			
		||||
esphome/components/ens160_spi/* @latonita
 | 
			
		||||
esphome/components/ens210/* @itn3rd77
 | 
			
		||||
esphome/components/es7210/* @kahrendt
 | 
			
		||||
esphome/components/es7243e/* @kbx81
 | 
			
		||||
esphome/components/es8156/* @kbx81
 | 
			
		||||
esphome/components/es8311/* @kahrendt @kroimon
 | 
			
		||||
esphome/components/esp32/* @esphome/core
 | 
			
		||||
esphome/components/esp32_ble/* @Rapsssito @jesserockz
 | 
			
		||||
esphome/components/esp32_ble_client/* @jesserockz
 | 
			
		||||
@@ -148,7 +133,6 @@ esphome/components/esp32_rmt_led_strip/* @jesserockz
 | 
			
		||||
esphome/components/esp8266/* @esphome/core
 | 
			
		||||
esphome/components/ethernet_info/* @gtjadsonsantos
 | 
			
		||||
esphome/components/event/* @nohat
 | 
			
		||||
esphome/components/event_emitter/* @Rapsssito
 | 
			
		||||
esphome/components/exposure_notifications/* @OttoWinter
 | 
			
		||||
esphome/components/ezo/* @ssieb
 | 
			
		||||
esphome/components/ezo_pmp/* @carlos-sarmiento
 | 
			
		||||
@@ -163,7 +147,6 @@ 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
 | 
			
		||||
@@ -171,7 +154,6 @@ 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/gt911/* @clydebarrow @jesserockz
 | 
			
		||||
@@ -179,12 +161,10 @@ 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/hbridge/switch/* @dwmw2
 | 
			
		||||
esphome/components/he60r/* @clydebarrow
 | 
			
		||||
esphome/components/heatpumpir/* @rob-deutsch
 | 
			
		||||
esphome/components/hitachi_ac424/* @sourabhjaiswal
 | 
			
		||||
@@ -206,11 +186,10 @@ 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 @kahrendt
 | 
			
		||||
esphome/components/i2s_audio/speaker/* @jesserockz
 | 
			
		||||
esphome/components/iaqcore/* @yozik04
 | 
			
		||||
esphome/components/ili9xxx/* @clydebarrow @nielsnl68
 | 
			
		||||
esphome/components/improv_base/* @esphome/core
 | 
			
		||||
@@ -242,14 +221,11 @@ esphome/components/lightwaverf/* @max246
 | 
			
		||||
esphome/components/lilygo_t5_47/touchscreen/* @jesserockz
 | 
			
		||||
esphome/components/lock/* @esphome/core
 | 
			
		||||
esphome/components/logger/* @esphome/core
 | 
			
		||||
esphome/components/logger/select/* @clydebarrow
 | 
			
		||||
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
 | 
			
		||||
@@ -278,7 +254,6 @@ esphome/components/mics_4514/* @jesserockz
 | 
			
		||||
esphome/components/midea/* @dudanov
 | 
			
		||||
esphome/components/midea_ir/* @dudanov
 | 
			
		||||
esphome/components/mitsubishi/* @RubyBailey
 | 
			
		||||
esphome/components/mixer/speaker/* @kahrendt
 | 
			
		||||
esphome/components/mlx90393/* @functionpointer
 | 
			
		||||
esphome/components/mlx90614/* @jesserockz
 | 
			
		||||
esphome/components/mmc5603/* @benhoff
 | 
			
		||||
@@ -297,7 +272,6 @@ 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/* @edwardtfn @senexcrenshaw
 | 
			
		||||
esphome/components/nextion/binary_sensor/* @senexcrenshaw
 | 
			
		||||
@@ -306,11 +280,9 @@ esphome/components/nextion/switch/* @senexcrenshaw
 | 
			
		||||
esphome/components/nextion/text_sensor/* @senexcrenshaw
 | 
			
		||||
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/* @clydebarrow @guillempages
 | 
			
		||||
esphome/components/opentherm/* @olegtarasov
 | 
			
		||||
esphome/components/online_image/* @guillempages
 | 
			
		||||
esphome/components/ota/* @esphome/core
 | 
			
		||||
esphome/components/output/* @esphome/core
 | 
			
		||||
esphome/components/pca6416a/* @Mat931
 | 
			
		||||
@@ -338,14 +310,14 @@ 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/qspi_amoled/* @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/resampler/speaker/* @kahrendt
 | 
			
		||||
esphome/components/resistance_sampler/* @jesserockz
 | 
			
		||||
esphome/components/restart/* @esphome/core
 | 
			
		||||
esphome/components/rf_bridge/* @jesserockz
 | 
			
		||||
esphome/components/rgbct/* @jesserockz
 | 
			
		||||
@@ -358,12 +330,10 @@ esphome/components/rtttl/* @glmnet
 | 
			
		||||
esphome/components/safe_mode/* @jsuanet @kbx81 @paulmonigatti
 | 
			
		||||
esphome/components/scd4x/* @martgras @sjtrny
 | 
			
		||||
esphome/components/script/* @esphome/core
 | 
			
		||||
esphome/components/sdl/* @bdm310 @clydebarrow
 | 
			
		||||
esphome/components/sdl/* @clydebarrow
 | 
			
		||||
esphome/components/sdm_meter/* @jesserockz @polyfaces
 | 
			
		||||
esphome/components/sdp3x/* @Azimath
 | 
			
		||||
esphome/components/seeed_mr24hpc1/* @limengdu
 | 
			
		||||
esphome/components/seeed_mr60bha2/* @limengdu
 | 
			
		||||
esphome/components/seeed_mr60fda2/* @limengdu
 | 
			
		||||
esphome/components/selec_meter/* @sourabhjaiswal
 | 
			
		||||
esphome/components/select/* @esphome/core
 | 
			
		||||
esphome/components/sen0321/* @notjj
 | 
			
		||||
@@ -389,8 +359,7 @@ esphome/components/smt100/* @piechade
 | 
			
		||||
esphome/components/sn74hc165/* @jesserockz
 | 
			
		||||
esphome/components/socket/* @esphome/core
 | 
			
		||||
esphome/components/sonoff_d1/* @anatoly-savchenkov
 | 
			
		||||
esphome/components/speaker/* @jesserockz @kahrendt
 | 
			
		||||
esphome/components/speaker/media_player/* @kahrendt @synesthesiam
 | 
			
		||||
esphome/components/speaker/* @jesserockz
 | 
			
		||||
esphome/components/spi/* @clydebarrow @esphome/core
 | 
			
		||||
esphome/components/spi_device/* @clydebarrow
 | 
			
		||||
esphome/components/spi_led_strip/* @clydebarrow
 | 
			
		||||
@@ -414,20 +383,15 @@ 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/switch/binary_sensor/* @ssieb
 | 
			
		||||
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
 | 
			
		||||
@@ -458,7 +422,6 @@ 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
 | 
			
		||||
@@ -501,6 +464,5 @@ esphome/components/xiaomi_mhoc401/* @vevsvevs
 | 
			
		||||
esphome/components/xiaomi_rtcgq02lm/* @jesserockz
 | 
			
		||||
esphome/components/xl9535/* @mreditor97
 | 
			
		||||
esphome/components/xpt2046/touchscreen/* @nielsnl68 @numo68
 | 
			
		||||
esphome/components/xxtea/* @clydebarrow
 | 
			
		||||
esphome/components/zhlt01/* @cfeenstra1024
 | 
			
		||||
esphome/components/zio_ultrasonic/* @kahrendt
 | 
			
		||||
 
 | 
			
		||||
@@ -1,14 +1,12 @@
 | 
			
		||||
# Contributing to ESPHome [](https://discord.gg/KhAMKrd) [](https://GitHub.com/esphome/esphome/releases/)
 | 
			
		||||
# Contributing to ESPHome
 | 
			
		||||
 | 
			
		||||
We welcome contributions to the ESPHome suite of code and documentation!
 | 
			
		||||
For a detailed guide, please see https://esphome.io/guides/contributing.html#contributing-to-esphome
 | 
			
		||||
 | 
			
		||||
Please read our [contributing guide](https://esphome.io/guides/contributing.html) if you wish to contribute to the
 | 
			
		||||
project and be sure to join us on [Discord](https://discord.gg/KhAMKrd).
 | 
			
		||||
Things to note when contributing:
 | 
			
		||||
 | 
			
		||||
**See also:**
 | 
			
		||||
 | 
			
		||||
[Documentation](https://esphome.io) -- [Issues](https://github.com/esphome/issues/issues) -- [Feature requests](https://github.com/esphome/feature-requests/issues)
 | 
			
		||||
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
[](https://www.openhomefoundation.org/)
 | 
			
		||||
 - Please test your changes :)
 | 
			
		||||
 - If a new feature is added or an existing user-facing feature is changed, you should also
 | 
			
		||||
   update the [docs](https://github.com/esphome/esphome-docs). See [contributing to esphome-docs](https://esphome.io/guides/contributing.html#contributing-to-esphomedocs)
 | 
			
		||||
   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.
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										15
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										15
									
								
								README.md
									
									
									
									
									
								
							@@ -1,16 +1,9 @@
 | 
			
		||||
# ESPHome [](https://discord.gg/KhAMKrd) [](https://GitHub.com/esphome/esphome/releases/)
 | 
			
		||||
 | 
			
		||||
<a href="https://esphome.io/">
 | 
			
		||||
  <picture>
 | 
			
		||||
    <source media="(prefers-color-scheme: dark)" srcset="https://esphome.io/_static/logo-text-on-dark.svg", alt="ESPHome Logo">
 | 
			
		||||
    <img src="https://esphome.io/_static/logo-text-on-light.svg" alt="ESPHome Logo">
 | 
			
		||||
  </picture>
 | 
			
		||||
</a>
 | 
			
		||||
[](https://esphome.io/)
 | 
			
		||||
 | 
			
		||||
---
 | 
			
		||||
**Documentation:** https://esphome.io/
 | 
			
		||||
 | 
			
		||||
[Documentation](https://esphome.io) -- [Issues](https://github.com/esphome/issues/issues) -- [Feature requests](https://github.com/esphome/feature-requests/issues)
 | 
			
		||||
For issues, please go to [the issue tracker](https://github.com/esphome/issues/issues).
 | 
			
		||||
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
[](https://www.openhomefoundation.org/)
 | 
			
		||||
For feature requests, please see [feature requests](https://github.com/esphome/feature-requests/issues).
 | 
			
		||||
 
 | 
			
		||||
@@ -29,17 +29,36 @@ RUN \
 | 
			
		||||
    # Use pinned versions so that we get updates with build caching
 | 
			
		||||
    && apt-get install -y --no-install-recommends \
 | 
			
		||||
        python3-pip=23.0.1+dfsg-1 \
 | 
			
		||||
        python3-setuptools=66.1.1-1+deb12u1 \
 | 
			
		||||
        python3-setuptools=66.1.1-1 \
 | 
			
		||||
        python3-venv=3.11.2-1+b1 \
 | 
			
		||||
        python3-wheel=0.38.4-2 \
 | 
			
		||||
        iputils-ping=3:20221126-1+deb12u1 \
 | 
			
		||||
        git=1:2.39.5-0+deb12u1 \
 | 
			
		||||
        curl=7.88.1-10+deb12u8 \
 | 
			
		||||
        openssh-client=1:9.2p1-2+deb12u4 \
 | 
			
		||||
        iputils-ping=3:20221126-1 \
 | 
			
		||||
        git=1:2.39.2-1.1 \
 | 
			
		||||
        curl=7.88.1-10+deb12u6 \
 | 
			
		||||
        openssh-client=1:9.2p1-2+deb12u2 \
 | 
			
		||||
        python3-cffi=1.15.1-5 \
 | 
			
		||||
        libcairo2=1.16.0-7 \
 | 
			
		||||
        libmagic1=1:5.44-3 \
 | 
			
		||||
        patch=2.7.6-7 \
 | 
			
		||||
    && ( \
 | 
			
		||||
        ( \
 | 
			
		||||
            [ "$TARGETARCH$TARGETVARIANT" = "armv7" ] && \
 | 
			
		||||
                apt-get install -y --no-install-recommends \
 | 
			
		||||
                build-essential=12.9 \
 | 
			
		||||
                python3-dev=3.11.2-1+b1 \
 | 
			
		||||
                zlib1g-dev=1:1.2.13.dfsg-1 \
 | 
			
		||||
                libjpeg-dev=1:2.1.5-2 \
 | 
			
		||||
                libfreetype-dev=2.12.1+dfsg-5+deb12u3 \
 | 
			
		||||
                libssl-dev=3.0.13-1~deb12u1 \
 | 
			
		||||
                libffi-dev=3.4.4-1 \
 | 
			
		||||
                libopenjp2-7=2.5.0-2 \
 | 
			
		||||
                libtiff6=4.5.0-6+deb12u1 \
 | 
			
		||||
                cargo=0.66.0+ds1-1 \
 | 
			
		||||
                pkg-config=1.8.1-1 \
 | 
			
		||||
                gcc-arm-linux-gnueabihf=4:12.2.0-3 \
 | 
			
		||||
        ) \
 | 
			
		||||
        || [ "$TARGETARCH$TARGETVARIANT" != "armv7" ] \
 | 
			
		||||
    ) \
 | 
			
		||||
    && rm -rf \
 | 
			
		||||
        /tmp/* \
 | 
			
		||||
        /var/{cache,log}/* \
 | 
			
		||||
@@ -51,11 +70,23 @@ ENV \
 | 
			
		||||
  # Store globally installed pio libs in /piolibs
 | 
			
		||||
  PLATFORMIO_GLOBALLIB_DIR=/piolibs
 | 
			
		||||
 | 
			
		||||
# Support legacy binaries on Debian multiarch system. There is no "correct" way
 | 
			
		||||
# to do this, other than using properly built toolchains...
 | 
			
		||||
# 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-armhf.so.3 /lib/ld-linux.so.3; \
 | 
			
		||||
    fi
 | 
			
		||||
 | 
			
		||||
RUN \
 | 
			
		||||
    # Ubuntu python3-pip is missing wheel
 | 
			
		||||
    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 \
 | 
			
		||||
    platformio==6.1.15 \
 | 
			
		||||
    # Change some platformio settings
 | 
			
		||||
    && platformio settings set enable_telemetry No \
 | 
			
		||||
    && platformio settings set check_platformio_interval 1000000 \
 | 
			
		||||
@@ -65,46 +96,14 @@ RUN \
 | 
			
		||||
# First install requirements to leverage caching when requirements don't change
 | 
			
		||||
# tmpfs is for https://github.com/rust-lang/cargo/issues/8719
 | 
			
		||||
 | 
			
		||||
COPY requirements.txt requirements_optional.txt /
 | 
			
		||||
RUN --mount=type=tmpfs,target=/root/.cargo <<END-OF-RUN
 | 
			
		||||
# Fail on any non-zero status
 | 
			
		||||
set -e
 | 
			
		||||
 | 
			
		||||
# install build tools in case wheels are not available
 | 
			
		||||
BUILD_DEPS="
 | 
			
		||||
    build-essential=12.9
 | 
			
		||||
    python3-dev=3.11.2-1+b1
 | 
			
		||||
    zlib1g-dev=1:1.2.13.dfsg-1
 | 
			
		||||
    libjpeg-dev=1:2.1.5-2
 | 
			
		||||
    libfreetype-dev=2.12.1+dfsg-5+deb12u3
 | 
			
		||||
    libssl-dev=3.0.15-1~deb12u1
 | 
			
		||||
    libffi-dev=3.4.4-1
 | 
			
		||||
    cargo=0.66.0+ds1-1
 | 
			
		||||
    pkg-config=1.8.1-1
 | 
			
		||||
"
 | 
			
		||||
LIB_DEPS="
 | 
			
		||||
    libtiff6=4.5.0-6+deb12u1
 | 
			
		||||
    libopenjp2-7=2.5.0-2
 | 
			
		||||
"
 | 
			
		||||
if [ "$TARGETARCH$TARGETVARIANT" = "arm64" ]
 | 
			
		||||
then
 | 
			
		||||
    apt-get update
 | 
			
		||||
    apt-get install -y --no-install-recommends $BUILD_DEPS $LIB_DEPS
 | 
			
		||||
fi
 | 
			
		||||
 | 
			
		||||
CARGO_REGISTRIES_CRATES_IO_PROTOCOL=sparse CARGO_HOME=/root/.cargo
 | 
			
		||||
pip3 install --break-system-packages --no-cache-dir -r /requirements.txt -r /requirements_optional.txt
 | 
			
		||||
 | 
			
		||||
if [ "$TARGETARCH$TARGETVARIANT" = "arm64" ]
 | 
			
		||||
then
 | 
			
		||||
    apt-get remove -y --purge --auto-remove $BUILD_DEPS
 | 
			
		||||
    rm -rf /tmp/* /var/{cache,log}/* /var/lib/apt/lists/*
 | 
			
		||||
fi
 | 
			
		||||
END-OF-RUN
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
COPY script/platformio_install_deps.py platformio.ini /
 | 
			
		||||
RUN /platformio_install_deps.py /platformio.ini --libraries
 | 
			
		||||
COPY requirements.txt requirements_optional.txt script/platformio_install_deps.py platformio.ini /
 | 
			
		||||
RUN --mount=type=tmpfs,target=/root/.cargo if [ "$TARGETARCH$TARGETVARIANT" = "armv7" ]; then \
 | 
			
		||||
        export PIP_EXTRA_INDEX_URL="https://www.piwheels.org/simple"; \
 | 
			
		||||
    fi; \
 | 
			
		||||
    CARGO_REGISTRIES_CRATES_IO_PROTOCOL=sparse CARGO_HOME=/root/.cargo \
 | 
			
		||||
    pip3 install \
 | 
			
		||||
    --break-system-packages --no-cache-dir -r /requirements.txt -r /requirements_optional.txt \
 | 
			
		||||
    && /platformio_install_deps.py /platformio.ini --libraries
 | 
			
		||||
 | 
			
		||||
# Avoid unsafe git error when container user and file config volume permissions don't match
 | 
			
		||||
RUN git config --system --add safe.directory '*'
 | 
			
		||||
@@ -115,7 +114,11 @@ FROM base AS docker
 | 
			
		||||
 | 
			
		||||
# Copy esphome and install
 | 
			
		||||
COPY . /esphome
 | 
			
		||||
RUN pip3 install --break-system-packages --no-cache-dir -e /esphome
 | 
			
		||||
RUN if [ "$TARGETARCH$TARGETVARIANT" = "armv7" ]; then \
 | 
			
		||||
        export PIP_EXTRA_INDEX_URL="https://www.piwheels.org/simple"; \
 | 
			
		||||
  fi; \
 | 
			
		||||
  pip3 install \
 | 
			
		||||
  --break-system-packages --no-cache-dir -e /esphome
 | 
			
		||||
 | 
			
		||||
# Settings for dashboard
 | 
			
		||||
ENV USERNAME="" PASSWORD=""
 | 
			
		||||
@@ -139,18 +142,6 @@ ENTRYPOINT ["/entrypoint.sh"]
 | 
			
		||||
CMD ["dashboard", "/config"]
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
ARG BUILD_VERSION=dev
 | 
			
		||||
 | 
			
		||||
# Labels
 | 
			
		||||
LABEL \
 | 
			
		||||
    org.opencontainers.image.authors="The ESPHome Authors" \
 | 
			
		||||
    org.opencontainers.image.title="ESPHome" \
 | 
			
		||||
    org.opencontainers.image.description="ESPHome is a system to configure your microcontrollers by simple yet powerful configuration files and control them remotely through Home Automation systems" \
 | 
			
		||||
    org.opencontainers.image.url="https://esphome.io/" \
 | 
			
		||||
    org.opencontainers.image.documentation="https://esphome.io/" \
 | 
			
		||||
    org.opencontainers.image.source="https://github.com/esphome/esphome" \
 | 
			
		||||
    org.opencontainers.image.licenses="ESPHome" \
 | 
			
		||||
    org.opencontainers.image.version=${BUILD_VERSION}
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
# ======================= hassio-type image =======================
 | 
			
		||||
@@ -173,12 +164,16 @@ COPY docker/ha-addon-rootfs/ /
 | 
			
		||||
 | 
			
		||||
# Copy esphome and install
 | 
			
		||||
COPY . /esphome
 | 
			
		||||
RUN pip3 install --break-system-packages --no-cache-dir -e /esphome
 | 
			
		||||
RUN if [ "$TARGETARCH$TARGETVARIANT" = "armv7" ]; then \
 | 
			
		||||
        export PIP_EXTRA_INDEX_URL="https://www.piwheels.org/simple"; \
 | 
			
		||||
  fi; \
 | 
			
		||||
  pip3 install \
 | 
			
		||||
  --break-system-packages --no-cache-dir -e /esphome
 | 
			
		||||
 | 
			
		||||
# Labels
 | 
			
		||||
LABEL \
 | 
			
		||||
    io.hass.name="ESPHome" \
 | 
			
		||||
    io.hass.description="ESPHome is a system to configure your microcontrollers by simple yet powerful configuration files and control them remotely through Home Automation systems" \
 | 
			
		||||
    io.hass.description="Manage and program ESP8266/ESP32 microcontrollers through YAML configuration files" \
 | 
			
		||||
    io.hass.type="addon" \
 | 
			
		||||
    io.hass.version="${BUILD_VERSION}"
 | 
			
		||||
    # io.hass.arch is inherited from addon-debian-base
 | 
			
		||||
@@ -193,25 +188,27 @@ ENV \
 | 
			
		||||
  PLATFORMIO_CORE_DIR=/esphome/.temp/platformio
 | 
			
		||||
 | 
			
		||||
RUN \
 | 
			
		||||
    curl -L https://apt.llvm.org/llvm-snapshot.gpg.key -o /etc/apt/trusted.gpg.d/apt.llvm.org.asc \
 | 
			
		||||
    && echo "deb http://apt.llvm.org/bookworm/ llvm-toolchain-bookworm-18 main" > /etc/apt/sources.list.d/llvm.sources.list \
 | 
			
		||||
    && apt-get update \
 | 
			
		||||
    apt-get update \
 | 
			
		||||
    # Use pinned versions so that we get updates with build caching
 | 
			
		||||
    && apt-get install -y --no-install-recommends \
 | 
			
		||||
        clang-format-13=1:13.0.1-11+b2 \
 | 
			
		||||
        clang-tidy-14=1:14.0.6-12 \
 | 
			
		||||
        patch=2.7.6-7 \
 | 
			
		||||
        software-properties-common=0.99.30-4.1~deb12u1 \
 | 
			
		||||
        nano=7.2-1+deb12u1 \
 | 
			
		||||
        build-essential=12.9 \
 | 
			
		||||
        python3-dev=3.11.2-1+b1 \
 | 
			
		||||
        clang-tidy-18=1:18.1.8~++20240731024826+3b5b5c1ec4a3-1~exp1~20240731144843.145 \
 | 
			
		||||
    && rm -rf \
 | 
			
		||||
        /tmp/* \
 | 
			
		||||
        /var/{cache,log}/* \
 | 
			
		||||
        /var/lib/apt/lists/*
 | 
			
		||||
 | 
			
		||||
COPY requirements_test.txt /
 | 
			
		||||
RUN pip3 install --break-system-packages --no-cache-dir -r /requirements_test.txt
 | 
			
		||||
RUN if [ "$TARGETARCH$TARGETVARIANT" = "armv7" ]; then \
 | 
			
		||||
        export PIP_EXTRA_INDEX_URL="https://www.piwheels.org/simple"; \
 | 
			
		||||
  fi; \
 | 
			
		||||
  pip3 install \
 | 
			
		||||
  --break-system-packages --no-cache-dir -r /requirements_test.txt
 | 
			
		||||
 | 
			
		||||
VOLUME ["/esphome"]
 | 
			
		||||
WORKDIR /esphome
 | 
			
		||||
 
 | 
			
		||||
@@ -1,19 +1,22 @@
 | 
			
		||||
#!/usr/bin/env python3
 | 
			
		||||
import argparse
 | 
			
		||||
from dataclasses import dataclass
 | 
			
		||||
import re
 | 
			
		||||
import shlex
 | 
			
		||||
import subprocess
 | 
			
		||||
import argparse
 | 
			
		||||
from platform import machine
 | 
			
		||||
import shlex
 | 
			
		||||
import re
 | 
			
		||||
import sys
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
CHANNEL_DEV = "dev"
 | 
			
		||||
CHANNEL_BETA = "beta"
 | 
			
		||||
CHANNEL_RELEASE = "release"
 | 
			
		||||
CHANNELS = [CHANNEL_DEV, CHANNEL_BETA, CHANNEL_RELEASE]
 | 
			
		||||
 | 
			
		||||
ARCH_AMD64 = "amd64"
 | 
			
		||||
ARCH_ARMV7 = "armv7"
 | 
			
		||||
ARCH_AARCH64 = "aarch64"
 | 
			
		||||
ARCHS = [ARCH_AMD64, ARCH_AARCH64]
 | 
			
		||||
ARCHS = [ARCH_AMD64, ARCH_ARMV7, ARCH_AARCH64]
 | 
			
		||||
 | 
			
		||||
TYPE_DOCKER = "docker"
 | 
			
		||||
TYPE_HA_ADDON = "ha-addon"
 | 
			
		||||
@@ -73,6 +76,7 @@ class DockerParams:
 | 
			
		||||
        }[build_type]
 | 
			
		||||
        platform = {
 | 
			
		||||
            ARCH_AMD64: "linux/amd64",
 | 
			
		||||
            ARCH_ARMV7: "linux/arm/v7",
 | 
			
		||||
            ARCH_AARCH64: "linux/arm64",
 | 
			
		||||
        }[arch]
 | 
			
		||||
        target = {
 | 
			
		||||
 
 | 
			
		||||
@@ -20,8 +20,6 @@ from esphome.const import (
 | 
			
		||||
    CONF_DEASSERT_RTS_DTR,
 | 
			
		||||
    CONF_DISABLED,
 | 
			
		||||
    CONF_ESPHOME,
 | 
			
		||||
    CONF_LEVEL,
 | 
			
		||||
    CONF_LOG_TOPIC,
 | 
			
		||||
    CONF_LOGGER,
 | 
			
		||||
    CONF_MDNS,
 | 
			
		||||
    CONF_MQTT,
 | 
			
		||||
@@ -32,7 +30,6 @@ from esphome.const import (
 | 
			
		||||
    CONF_PLATFORMIO_OPTIONS,
 | 
			
		||||
    CONF_PORT,
 | 
			
		||||
    CONF_SUBSTITUTIONS,
 | 
			
		||||
    CONF_TOPIC,
 | 
			
		||||
    PLATFORM_BK72XX,
 | 
			
		||||
    PLATFORM_ESP32,
 | 
			
		||||
    PLATFORM_ESP8266,
 | 
			
		||||
@@ -41,7 +38,7 @@ from esphome.const import (
 | 
			
		||||
    SECRETS_FILES,
 | 
			
		||||
)
 | 
			
		||||
from esphome.core import CORE, EsphomeError, coroutine
 | 
			
		||||
from esphome.helpers import get_bool_env, indent, is_ip_address
 | 
			
		||||
from esphome.helpers import indent, is_ip_address, get_bool_env
 | 
			
		||||
from esphome.log import Fore, color, setup_log
 | 
			
		||||
from esphome.util import (
 | 
			
		||||
    get_serial_ports,
 | 
			
		||||
@@ -98,12 +95,8 @@ def choose_upload_log_host(
 | 
			
		||||
        options.append((f"Over The Air ({CORE.address})", CORE.address))
 | 
			
		||||
        if default == "OTA":
 | 
			
		||||
            return CORE.address
 | 
			
		||||
    if (
 | 
			
		||||
        show_mqtt
 | 
			
		||||
        and (mqtt_config := CORE.config.get(CONF_MQTT))
 | 
			
		||||
        and mqtt_logging_enabled(mqtt_config)
 | 
			
		||||
    ):
 | 
			
		||||
        options.append((f"MQTT ({mqtt_config[CONF_BROKER]})", "MQTT"))
 | 
			
		||||
    if show_mqtt and CONF_MQTT in CORE.config:
 | 
			
		||||
        options.append((f"MQTT ({CORE.config['mqtt'][CONF_BROKER]})", "MQTT"))
 | 
			
		||||
        if default == "OTA":
 | 
			
		||||
            return "MQTT"
 | 
			
		||||
    if default is not None:
 | 
			
		||||
@@ -113,17 +106,6 @@ def choose_upload_log_host(
 | 
			
		||||
    return choose_prompt(options, purpose=purpose)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
def mqtt_logging_enabled(mqtt_config):
 | 
			
		||||
    log_topic = mqtt_config[CONF_LOG_TOPIC]
 | 
			
		||||
    if log_topic is None:
 | 
			
		||||
        return False
 | 
			
		||||
    if CONF_TOPIC not in log_topic:
 | 
			
		||||
        return False
 | 
			
		||||
    if log_topic.get(CONF_LEVEL, None) == "NONE":
 | 
			
		||||
        return False
 | 
			
		||||
    return True
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
def get_port_type(port):
 | 
			
		||||
    if port.startswith("/") or port.startswith("COM"):
 | 
			
		||||
        return "SERIAL"
 | 
			
		||||
@@ -363,7 +345,7 @@ def upload_program(config, args, host):
 | 
			
		||||
 | 
			
		||||
    from esphome import espota2
 | 
			
		||||
 | 
			
		||||
    remote_port = int(ota_conf[CONF_PORT])
 | 
			
		||||
    remote_port = ota_conf[CONF_PORT]
 | 
			
		||||
    password = ota_conf.get(CONF_PASSWORD, "")
 | 
			
		||||
 | 
			
		||||
    if (
 | 
			
		||||
@@ -396,7 +378,7 @@ def show_logs(config, args, port):
 | 
			
		||||
 | 
			
		||||
            port = mqtt.get_esphome_device_ip(
 | 
			
		||||
                config, args.username, args.password, args.client_id
 | 
			
		||||
            )[0]
 | 
			
		||||
            )
 | 
			
		||||
 | 
			
		||||
        from esphome.components.api.client import run_logs
 | 
			
		||||
 | 
			
		||||
@@ -758,14 +740,6 @@ def parse_args(argv):
 | 
			
		||||
    options_parser.add_argument(
 | 
			
		||||
        "-q", "--quiet", help="Disable all ESPHome logs.", action="store_true"
 | 
			
		||||
    )
 | 
			
		||||
    options_parser.add_argument(
 | 
			
		||||
        "-l",
 | 
			
		||||
        "--log-level",
 | 
			
		||||
        help="Set the log level.",
 | 
			
		||||
        default=os.getenv("ESPHOME_LOG_LEVEL", "INFO"),
 | 
			
		||||
        action="store",
 | 
			
		||||
        choices=["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"],
 | 
			
		||||
    )
 | 
			
		||||
    options_parser.add_argument(
 | 
			
		||||
        "--dashboard", help=argparse.SUPPRESS, action="store_true"
 | 
			
		||||
    )
 | 
			
		||||
@@ -995,16 +969,11 @@ def run_esphome(argv):
 | 
			
		||||
    args = parse_args(argv)
 | 
			
		||||
    CORE.dashboard = args.dashboard
 | 
			
		||||
 | 
			
		||||
    # Override log level if verbose is set
 | 
			
		||||
    if args.verbose:
 | 
			
		||||
        args.log_level = "DEBUG"
 | 
			
		||||
    elif args.quiet:
 | 
			
		||||
        args.log_level = "CRITICAL"
 | 
			
		||||
 | 
			
		||||
    setup_log(
 | 
			
		||||
        log_level=args.log_level,
 | 
			
		||||
        args.verbose,
 | 
			
		||||
        args.quiet,
 | 
			
		||||
        # Show timestamp for dashboard access logs
 | 
			
		||||
        include_timestamp=args.command == "dashboard",
 | 
			
		||||
        args.command == "dashboard",
 | 
			
		||||
    )
 | 
			
		||||
 | 
			
		||||
    if args.command in PRE_CONFIG_ACTIONS:
 | 
			
		||||
 
 | 
			
		||||
@@ -1,8 +1,6 @@
 | 
			
		||||
import esphome.codegen as cg
 | 
			
		||||
import esphome.config_validation as cv
 | 
			
		||||
from esphome.const import (
 | 
			
		||||
    CONF_ALL,
 | 
			
		||||
    CONF_ANY,
 | 
			
		||||
    CONF_AUTOMATION_ID,
 | 
			
		||||
    CONF_CONDITION,
 | 
			
		||||
    CONF_COUNT,
 | 
			
		||||
@@ -75,13 +73,6 @@ 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)
 | 
			
		||||
@@ -175,18 +166,6 @@ 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)
 | 
			
		||||
@@ -244,21 +223,15 @@ async def delay_action_to_code(config, action_id, template_arg, args):
 | 
			
		||||
    IfAction,
 | 
			
		||||
    cv.All(
 | 
			
		||||
        {
 | 
			
		||||
            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.Required(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):
 | 
			
		||||
    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)
 | 
			
		||||
    conditions = await build_condition(config[CONF_CONDITION], 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)
 | 
			
		||||
 
 | 
			
		||||
@@ -1,6 +1,11 @@
 | 
			
		||||
from esphome import pins
 | 
			
		||||
import esphome.codegen as cg
 | 
			
		||||
import esphome.config_validation as cv
 | 
			
		||||
from esphome import pins
 | 
			
		||||
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,
 | 
			
		||||
@@ -10,9 +15,6 @@ from esphome.components.esp32.const import (
 | 
			
		||||
    VARIANT_ESP32S2,
 | 
			
		||||
    VARIANT_ESP32S3,
 | 
			
		||||
)
 | 
			
		||||
import esphome.config_validation as cv
 | 
			
		||||
from esphome.const import CONF_ANALOG, CONF_INPUT, CONF_NUMBER, PLATFORM_ESP8266
 | 
			
		||||
from esphome.core import CORE
 | 
			
		||||
 | 
			
		||||
CODEOWNERS = ["@esphome/core"]
 | 
			
		||||
 | 
			
		||||
@@ -36,14 +38,6 @@ ATTENUATION_MODES = {
 | 
			
		||||
    "auto": "auto",
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
sampling_mode = adc_ns.enum("SamplingMode", is_class=True)
 | 
			
		||||
 | 
			
		||||
SAMPLING_MODES = {
 | 
			
		||||
    "avg": sampling_mode.AVG,
 | 
			
		||||
    "min": sampling_mode.MIN,
 | 
			
		||||
    "max": sampling_mode.MAX,
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
adc1_channel_t = cg.global_ns.enum("adc1_channel_t")
 | 
			
		||||
adc2_channel_t = cg.global_ns.enum("adc2_channel_t")
 | 
			
		||||
 | 
			
		||||
@@ -108,11 +102,11 @@ ESP32_VARIANT_ADC1_PIN_TO_CHANNEL = {
 | 
			
		||||
        6: adc1_channel_t.ADC1_CHANNEL_6,
 | 
			
		||||
    },
 | 
			
		||||
    VARIANT_ESP32H2: {
 | 
			
		||||
        1: adc1_channel_t.ADC1_CHANNEL_0,
 | 
			
		||||
        2: adc1_channel_t.ADC1_CHANNEL_1,
 | 
			
		||||
        3: adc1_channel_t.ADC1_CHANNEL_2,
 | 
			
		||||
        4: adc1_channel_t.ADC1_CHANNEL_3,
 | 
			
		||||
        5: adc1_channel_t.ADC1_CHANNEL_4,
 | 
			
		||||
        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,
 | 
			
		||||
    },
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -1,13 +1,30 @@
 | 
			
		||||
#ifdef USE_ESP32
 | 
			
		||||
 | 
			
		||||
#include "adc_sensor.h"
 | 
			
		||||
#include "esphome/core/helpers.h"
 | 
			
		||||
#include "esphome/core/log.h"
 | 
			
		||||
 | 
			
		||||
#ifdef USE_ESP8266
 | 
			
		||||
#ifdef USE_ADC_SENSOR_VCC
 | 
			
		||||
#include <Esp.h>
 | 
			
		||||
ADC_MODE(ADC_VCC)
 | 
			
		||||
#else
 | 
			
		||||
#include <Arduino.h>
 | 
			
		||||
#endif
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_RP2040
 | 
			
		||||
#ifdef CYW43_USES_VSYS_PIN
 | 
			
		||||
#include "pico/cyw43_arch.h"
 | 
			
		||||
#endif
 | 
			
		||||
#include <hardware/adc.h>
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace adc {
 | 
			
		||||
 | 
			
		||||
static const char *const TAG = "adc.esp32";
 | 
			
		||||
static const char *const TAG = "adc";
 | 
			
		||||
 | 
			
		||||
// 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_bits_width_t>(ADC_WIDTH_MAX - 1);
 | 
			
		||||
 | 
			
		||||
#ifndef SOC_ADC_RTC_MAX_BITWIDTH
 | 
			
		||||
@@ -15,15 +32,24 @@ static const adc_bits_width_t ADC_WIDTH_MAX_SOC_BITS = static_cast<adc_bits_widt
 | 
			
		||||
static const int32_t SOC_ADC_RTC_MAX_BITWIDTH = 13;
 | 
			
		||||
#else
 | 
			
		||||
static const int32_t SOC_ADC_RTC_MAX_BITWIDTH = 12;
 | 
			
		||||
#endif  // USE_ESP32_VARIANT_ESP32S2
 | 
			
		||||
#endif  // SOC_ADC_RTC_MAX_BITWIDTH
 | 
			
		||||
#endif
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
static const int ADC_MAX = (1 << SOC_ADC_RTC_MAX_BITWIDTH) - 1;
 | 
			
		||||
static const int ADC_HALF = (1 << SOC_ADC_RTC_MAX_BITWIDTH) >> 1;
 | 
			
		||||
static const int ADC_MAX = (1 << SOC_ADC_RTC_MAX_BITWIDTH) - 1;    // 4095 (12 bit) or 8191 (13 bit)
 | 
			
		||||
static const int ADC_HALF = (1 << SOC_ADC_RTC_MAX_BITWIDTH) >> 1;  // 2048 (12 bit) or 4096 (13 bit)
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
void ADCSensor::setup() {
 | 
			
		||||
#ifdef USE_RP2040
 | 
			
		||||
extern "C"
 | 
			
		||||
#endif
 | 
			
		||||
    void
 | 
			
		||||
    ADCSensor::setup() {
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "Setting up ADC '%s'...", this->get_name().c_str());
 | 
			
		||||
#if !defined(USE_ADC_SENSOR_VCC) && !defined(USE_RP2040)
 | 
			
		||||
  this->pin_->setup();
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_ESP32
 | 
			
		||||
  if (this->channel1_ != ADC1_CHANNEL_MAX) {
 | 
			
		||||
    adc1_config_width(ADC_WIDTH_MAX_SOC_BITS);
 | 
			
		||||
    if (!this->autorange_) {
 | 
			
		||||
@@ -35,6 +61,7 @@ void ADCSensor::setup() {
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // load characteristics for each attenuation
 | 
			
		||||
  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,
 | 
			
		||||
@@ -52,10 +79,31 @@ void ADCSensor::setup() {
 | 
			
		||||
        break;
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
#endif  // USE_ESP32
 | 
			
		||||
 | 
			
		||||
#ifdef USE_RP2040
 | 
			
		||||
  static bool initialized = false;
 | 
			
		||||
  if (!initialized) {
 | 
			
		||||
    adc_init();
 | 
			
		||||
    initialized = true;
 | 
			
		||||
  }
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "ADC '%s' setup finished!", this->get_name().c_str());
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void ADCSensor::dump_config() {
 | 
			
		||||
  LOG_SENSOR("", "ADC Sensor", this);
 | 
			
		||||
#if defined(USE_ESP8266) || defined(USE_LIBRETINY)
 | 
			
		||||
#ifdef USE_ADC_SENSOR_VCC
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "  Pin: VCC");
 | 
			
		||||
#else
 | 
			
		||||
  LOG_PIN("  Pin: ", this->pin_);
 | 
			
		||||
#endif
 | 
			
		||||
#endif  // USE_ESP8266 || USE_LIBRETINY
 | 
			
		||||
 | 
			
		||||
#ifdef USE_ESP32
 | 
			
		||||
  LOG_PIN("  Pin: ", this->pin_);
 | 
			
		||||
  if (this->autorange_) {
 | 
			
		||||
    ESP_LOGCONFIG(TAG, "  Attenuation: auto");
 | 
			
		||||
@@ -77,15 +125,58 @@ void ADCSensor::dump_config() {
 | 
			
		||||
        break;
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
#endif  // USE_ESP32
 | 
			
		||||
 | 
			
		||||
#ifdef USE_RP2040
 | 
			
		||||
  if (this->is_temperature_) {
 | 
			
		||||
    ESP_LOGCONFIG(TAG, "  Pin: Temperature");
 | 
			
		||||
  } else {
 | 
			
		||||
#ifdef USE_ADC_SENSOR_VCC
 | 
			
		||||
    ESP_LOGCONFIG(TAG, "  Pin: VCC");
 | 
			
		||||
#else
 | 
			
		||||
    LOG_PIN("  Pin: ", this->pin_);
 | 
			
		||||
#endif  // USE_ADC_SENSOR_VCC
 | 
			
		||||
  }
 | 
			
		||||
#endif  // USE_RP2040
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "  Samples: %i", this->sample_count_);
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "  Sampling mode: %s", LOG_STR_ARG(sampling_mode_to_str(this->sampling_mode_)));
 | 
			
		||||
  LOG_UPDATE_INTERVAL(this);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
float ADCSensor::get_setup_priority() const { return setup_priority::DATA; }
 | 
			
		||||
void ADCSensor::update() {
 | 
			
		||||
  float value_v = this->sample();
 | 
			
		||||
  ESP_LOGV(TAG, "'%s': Got voltage=%.4fV", this->get_name().c_str(), value_v);
 | 
			
		||||
  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
 | 
			
		||||
    raw += ESP.getVcc();  // NOLINT(readability-static-accessed-through-instance)
 | 
			
		||||
#else
 | 
			
		||||
    raw += analogRead(this->pin_->get_pin());  // NOLINT
 | 
			
		||||
#endif
 | 
			
		||||
  }
 | 
			
		||||
  raw = (raw + (this->sample_count_ >> 1)) / this->sample_count_;  // NOLINT(clang-analyzer-core.DivideZero)
 | 
			
		||||
  if (this->output_raw_) {
 | 
			
		||||
    return raw;
 | 
			
		||||
  }
 | 
			
		||||
  return raw / 1024.0f;
 | 
			
		||||
}
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_ESP32
 | 
			
		||||
float ADCSensor::sample() {
 | 
			
		||||
  if (!this->autorange_) {
 | 
			
		||||
    auto aggr = Aggregator(this->sampling_mode_);
 | 
			
		||||
 | 
			
		||||
    uint32_t sum = 0;
 | 
			
		||||
    for (uint8_t sample = 0; sample < this->sample_count_; sample++) {
 | 
			
		||||
      int raw = -1;
 | 
			
		||||
      if (this->channel1_ != ADC1_CHANNEL_MAX) {
 | 
			
		||||
@@ -96,14 +187,13 @@ float ADCSensor::sample() {
 | 
			
		||||
      if (raw == -1) {
 | 
			
		||||
        return NAN;
 | 
			
		||||
      }
 | 
			
		||||
 | 
			
		||||
      aggr.add_sample(raw);
 | 
			
		||||
      sum += raw;
 | 
			
		||||
    }
 | 
			
		||||
    sum = (sum + (this->sample_count_ >> 1)) / this->sample_count_;  // NOLINT(clang-analyzer-core.DivideZero)
 | 
			
		||||
    if (this->output_raw_) {
 | 
			
		||||
      return aggr.aggregate();
 | 
			
		||||
      return sum;
 | 
			
		||||
    }
 | 
			
		||||
    uint32_t mv =
 | 
			
		||||
        esp_adc_cal_raw_to_voltage(aggr.aggregate(), &this->cal_characteristics_[(int32_t) this->attenuation_]);
 | 
			
		||||
    uint32_t mv = esp_adc_cal_raw_to_voltage(sum, &this->cal_characteristics_[(int32_t) this->attenuation_]);
 | 
			
		||||
    return mv / 1000.0f;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
@@ -150,17 +240,93 @@ float ADCSensor::sample() {
 | 
			
		||||
  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 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 = c12 + c6 + c2 + c0;
 | 
			
		||||
 | 
			
		||||
  // each mv is max 3900; so max value is 3900*4096*4, fits in unsigned32
 | 
			
		||||
  uint32_t mv_scaled = (mv12 * c12) + (mv6 * c6) + (mv2 * c2) + (mv0 * c0);
 | 
			
		||||
  return mv_scaled / (float) (csum * 1000U);
 | 
			
		||||
}
 | 
			
		||||
#endif  // USE_ESP32
 | 
			
		||||
 | 
			
		||||
#ifdef USE_RP2040
 | 
			
		||||
float ADCSensor::sample() {
 | 
			
		||||
  if (this->is_temperature_) {
 | 
			
		||||
    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);
 | 
			
		||||
 | 
			
		||||
    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;
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
#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
 | 
			
		||||
 | 
			
		||||
}  // namespace adc
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
 | 
			
		||||
#endif  // USE_ESP32
 | 
			
		||||
@@ -3,12 +3,13 @@
 | 
			
		||||
#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 <esp_adc_cal.h>
 | 
			
		||||
#include "driver/adc.h"
 | 
			
		||||
#endif  // USE_ESP32
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace adc {
 | 
			
		||||
@@ -28,21 +29,6 @@ static const adc_atten_t ADC_ATTEN_DB_12_COMPAT = ADC_ATTEN_DB_11;
 | 
			
		||||
#endif
 | 
			
		||||
#endif  // USE_ESP32
 | 
			
		||||
 | 
			
		||||
enum class SamplingMode : uint8_t { AVG = 0, MIN = 1, MAX = 2 };
 | 
			
		||||
const LogString *sampling_mode_to_str(SamplingMode mode);
 | 
			
		||||
 | 
			
		||||
class Aggregator {
 | 
			
		||||
 public:
 | 
			
		||||
  void add_sample(uint32_t value);
 | 
			
		||||
  uint32_t aggregate();
 | 
			
		||||
  Aggregator(SamplingMode mode);
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  SamplingMode mode_{SamplingMode::AVG};
 | 
			
		||||
  uint32_t aggr_{0};
 | 
			
		||||
  uint32_t samples_{0};
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
class ADCSensor : public sensor::Sensor, public PollingComponent, public voltage_sampler::VoltageSampler {
 | 
			
		||||
 public:
 | 
			
		||||
#ifdef USE_ESP32
 | 
			
		||||
@@ -57,7 +43,7 @@ class ADCSensor : public sensor::Sensor, public PollingComponent, public voltage
 | 
			
		||||
    this->channel1_ = ADC1_CHANNEL_MAX;
 | 
			
		||||
  }
 | 
			
		||||
  void set_autorange(bool autorange) { this->autorange_ = autorange; }
 | 
			
		||||
#endif  // USE_ESP32
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
  /// Update ADC values
 | 
			
		||||
  void update() override;
 | 
			
		||||
@@ -69,26 +55,24 @@ class ADCSensor : public sensor::Sensor, public PollingComponent, public voltage
 | 
			
		||||
  void set_pin(InternalGPIOPin *pin) { this->pin_ = pin; }
 | 
			
		||||
  void set_output_raw(bool output_raw) { this->output_raw_ = output_raw; }
 | 
			
		||||
  void set_sample_count(uint8_t sample_count);
 | 
			
		||||
  void set_sampling_mode(SamplingMode sampling_mode);
 | 
			
		||||
  float sample() override;
 | 
			
		||||
 | 
			
		||||
#ifdef USE_ESP8266
 | 
			
		||||
  std::string unique_id() override;
 | 
			
		||||
#endif  // USE_ESP8266
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_RP2040
 | 
			
		||||
  void set_is_temperature() { this->is_temperature_ = true; }
 | 
			
		||||
#endif  // USE_RP2040
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  InternalGPIOPin *pin_;
 | 
			
		||||
  bool output_raw_{false};
 | 
			
		||||
  uint8_t sample_count_{1};
 | 
			
		||||
  SamplingMode sampling_mode_{SamplingMode::AVG};
 | 
			
		||||
 | 
			
		||||
#ifdef USE_RP2040
 | 
			
		||||
  bool is_temperature_{false};
 | 
			
		||||
#endif  // USE_RP2040
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_ESP32
 | 
			
		||||
  adc_atten_t attenuation_{ADC_ATTEN_DB_0};
 | 
			
		||||
@@ -99,8 +83,8 @@ class ADCSensor : public sensor::Sensor, public PollingComponent, public voltage
 | 
			
		||||
  esp_adc_cal_characteristics_t cal_characteristics_[SOC_ADC_ATTEN_NUM] = {};
 | 
			
		||||
#else
 | 
			
		||||
  esp_adc_cal_characteristics_t cal_characteristics_[ADC_ATTEN_MAX] = {};
 | 
			
		||||
#endif  // ESP_IDF_VERSION_MAJOR
 | 
			
		||||
#endif  // USE_ESP32
 | 
			
		||||
#endif
 | 
			
		||||
#endif
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
}  // namespace adc
 | 
			
		||||
 
 | 
			
		||||
@@ -1,79 +0,0 @@
 | 
			
		||||
#include "adc_sensor.h"
 | 
			
		||||
#include "esphome/core/log.h"
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace adc {
 | 
			
		||||
 | 
			
		||||
static const char *const TAG = "adc.common";
 | 
			
		||||
 | 
			
		||||
const LogString *sampling_mode_to_str(SamplingMode mode) {
 | 
			
		||||
  switch (mode) {
 | 
			
		||||
    case SamplingMode::AVG:
 | 
			
		||||
      return LOG_STR("average");
 | 
			
		||||
    case SamplingMode::MIN:
 | 
			
		||||
      return LOG_STR("minimum");
 | 
			
		||||
    case SamplingMode::MAX:
 | 
			
		||||
      return LOG_STR("maximum");
 | 
			
		||||
  }
 | 
			
		||||
  return LOG_STR("unknown");
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
Aggregator::Aggregator(SamplingMode mode) {
 | 
			
		||||
  this->mode_ = mode;
 | 
			
		||||
  // set to max uint if mode is "min"
 | 
			
		||||
  if (mode == SamplingMode::MIN) {
 | 
			
		||||
    this->aggr_ = UINT32_MAX;
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void Aggregator::add_sample(uint32_t value) {
 | 
			
		||||
  this->samples_ += 1;
 | 
			
		||||
 | 
			
		||||
  switch (this->mode_) {
 | 
			
		||||
    case SamplingMode::AVG:
 | 
			
		||||
      this->aggr_ += value;
 | 
			
		||||
      break;
 | 
			
		||||
 | 
			
		||||
    case SamplingMode::MIN:
 | 
			
		||||
      if (value < this->aggr_) {
 | 
			
		||||
        this->aggr_ = value;
 | 
			
		||||
      }
 | 
			
		||||
      break;
 | 
			
		||||
 | 
			
		||||
    case SamplingMode::MAX:
 | 
			
		||||
      if (value > this->aggr_) {
 | 
			
		||||
        this->aggr_ = value;
 | 
			
		||||
      }
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
uint32_t Aggregator::aggregate() {
 | 
			
		||||
  if (this->mode_ == SamplingMode::AVG) {
 | 
			
		||||
    if (this->samples_ == 0) {
 | 
			
		||||
      return this->aggr_;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    return (this->aggr_ + (this->samples_ >> 1)) / this->samples_;  // NOLINT(clang-analyzer-core.DivideZero)
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  return this->aggr_;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void ADCSensor::update() {
 | 
			
		||||
  float value_v = this->sample();
 | 
			
		||||
  ESP_LOGV(TAG, "'%s': Got voltage=%.4fV", this->get_name().c_str(), value_v);
 | 
			
		||||
  this->publish_state(value_v);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void ADCSensor::set_sample_count(uint8_t sample_count) {
 | 
			
		||||
  if (sample_count != 0) {
 | 
			
		||||
    this->sample_count_ = sample_count;
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void ADCSensor::set_sampling_mode(SamplingMode sampling_mode) { this->sampling_mode_ = sampling_mode; }
 | 
			
		||||
 | 
			
		||||
float ADCSensor::get_setup_priority() const { return setup_priority::DATA; }
 | 
			
		||||
 | 
			
		||||
}  // namespace adc
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
@@ -1,62 +0,0 @@
 | 
			
		||||
#ifdef USE_ESP8266
 | 
			
		||||
 | 
			
		||||
#include "adc_sensor.h"
 | 
			
		||||
#include "esphome/core/helpers.h"
 | 
			
		||||
#include "esphome/core/log.h"
 | 
			
		||||
 | 
			
		||||
#ifdef USE_ADC_SENSOR_VCC
 | 
			
		||||
#include <Esp.h>
 | 
			
		||||
ADC_MODE(ADC_VCC)
 | 
			
		||||
#else
 | 
			
		||||
#include <Arduino.h>
 | 
			
		||||
#endif  // USE_ADC_SENSOR_VCC
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace adc {
 | 
			
		||||
 | 
			
		||||
static const char *const TAG = "adc.esp8266";
 | 
			
		||||
 | 
			
		||||
void ADCSensor::setup() {
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "Setting up ADC '%s'...", this->get_name().c_str());
 | 
			
		||||
#ifndef USE_ADC_SENSOR_VCC
 | 
			
		||||
  this->pin_->setup();
 | 
			
		||||
#endif
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void ADCSensor::dump_config() {
 | 
			
		||||
  LOG_SENSOR("", "ADC Sensor", this);
 | 
			
		||||
#ifdef USE_ADC_SENSOR_VCC
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "  Pin: VCC");
 | 
			
		||||
#else
 | 
			
		||||
  LOG_PIN("  Pin: ", this->pin_);
 | 
			
		||||
#endif  // USE_ADC_SENSOR_VCC
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "  Samples: %i", this->sample_count_);
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "  Sampling mode: %s", LOG_STR_ARG(sampling_mode_to_str(this->sampling_mode_)));
 | 
			
		||||
  LOG_UPDATE_INTERVAL(this);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
float ADCSensor::sample() {
 | 
			
		||||
  auto aggr = Aggregator(this->sampling_mode_);
 | 
			
		||||
 | 
			
		||||
  for (uint8_t sample = 0; sample < this->sample_count_; sample++) {
 | 
			
		||||
    uint32_t raw = 0;
 | 
			
		||||
#ifdef USE_ADC_SENSOR_VCC
 | 
			
		||||
    raw = ESP.getVcc();  // NOLINT(readability-static-accessed-through-instance)
 | 
			
		||||
#else
 | 
			
		||||
    raw = analogRead(this->pin_->get_pin());  // NOLINT
 | 
			
		||||
#endif  // USE_ADC_SENSOR_VCC
 | 
			
		||||
    aggr.add_sample(raw);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  if (this->output_raw_) {
 | 
			
		||||
    return aggr.aggregate();
 | 
			
		||||
  }
 | 
			
		||||
  return aggr.aggregate() / 1024.0f;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
std::string ADCSensor::unique_id() { return get_mac_address() + "-adc"; }
 | 
			
		||||
 | 
			
		||||
}  // namespace adc
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
 | 
			
		||||
#endif  // USE_ESP8266
 | 
			
		||||
@@ -1,53 +0,0 @@
 | 
			
		||||
#ifdef USE_LIBRETINY
 | 
			
		||||
 | 
			
		||||
#include "adc_sensor.h"
 | 
			
		||||
#include "esphome/core/log.h"
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace adc {
 | 
			
		||||
 | 
			
		||||
static const char *const TAG = "adc.libretiny";
 | 
			
		||||
 | 
			
		||||
void ADCSensor::setup() {
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "Setting up ADC '%s'...", this->get_name().c_str());
 | 
			
		||||
#ifndef USE_ADC_SENSOR_VCC
 | 
			
		||||
  this->pin_->setup();
 | 
			
		||||
#endif  // !USE_ADC_SENSOR_VCC
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void ADCSensor::dump_config() {
 | 
			
		||||
  LOG_SENSOR("", "ADC Sensor", this);
 | 
			
		||||
#ifdef USE_ADC_SENSOR_VCC
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "  Pin: VCC");
 | 
			
		||||
#else   // USE_ADC_SENSOR_VCC
 | 
			
		||||
  LOG_PIN("  Pin: ", this->pin_);
 | 
			
		||||
#endif  // USE_ADC_SENSOR_VCC
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "  Samples: %i", this->sample_count_);
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "  Sampling mode: %s", LOG_STR_ARG(sampling_mode_to_str(this->sampling_mode_)));
 | 
			
		||||
  LOG_UPDATE_INTERVAL(this);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
float ADCSensor::sample() {
 | 
			
		||||
  uint32_t raw = 0;
 | 
			
		||||
  auto aggr = Aggregator(this->sampling_mode_);
 | 
			
		||||
 | 
			
		||||
  if (this->output_raw_) {
 | 
			
		||||
    for (uint8_t sample = 0; sample < this->sample_count_; sample++) {
 | 
			
		||||
      raw = analogRead(this->pin_->get_pin());  // NOLINT
 | 
			
		||||
      aggr.add_sample(raw);
 | 
			
		||||
    }
 | 
			
		||||
    return aggr.aggregate();
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  for (uint8_t sample = 0; sample < this->sample_count_; sample++) {
 | 
			
		||||
    raw = analogReadVoltage(this->pin_->get_pin());  // NOLINT
 | 
			
		||||
    aggr.add_sample(raw);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  return aggr.aggregate() / 1000.0f;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
}  // namespace adc
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
 | 
			
		||||
#endif  // USE_LIBRETINY
 | 
			
		||||
@@ -1,96 +0,0 @@
 | 
			
		||||
#ifdef USE_RP2040
 | 
			
		||||
 | 
			
		||||
#include "adc_sensor.h"
 | 
			
		||||
#include "esphome/core/log.h"
 | 
			
		||||
 | 
			
		||||
#ifdef CYW43_USES_VSYS_PIN
 | 
			
		||||
#include "pico/cyw43_arch.h"
 | 
			
		||||
#endif  // CYW43_USES_VSYS_PIN
 | 
			
		||||
#include <hardware/adc.h>
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace adc {
 | 
			
		||||
 | 
			
		||||
static const char *const TAG = "adc.rp2040";
 | 
			
		||||
 | 
			
		||||
void ADCSensor::setup() {
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "Setting up ADC '%s'...", this->get_name().c_str());
 | 
			
		||||
  static bool initialized = false;
 | 
			
		||||
  if (!initialized) {
 | 
			
		||||
    adc_init();
 | 
			
		||||
    initialized = true;
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void ADCSensor::dump_config() {
 | 
			
		||||
  LOG_SENSOR("", "ADC Sensor", this);
 | 
			
		||||
  if (this->is_temperature_) {
 | 
			
		||||
    ESP_LOGCONFIG(TAG, "  Pin: Temperature");
 | 
			
		||||
  } else {
 | 
			
		||||
#ifdef USE_ADC_SENSOR_VCC
 | 
			
		||||
    ESP_LOGCONFIG(TAG, "  Pin: VCC");
 | 
			
		||||
#else
 | 
			
		||||
    LOG_PIN("  Pin: ", this->pin_);
 | 
			
		||||
#endif  // USE_ADC_SENSOR_VCC
 | 
			
		||||
  }
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "  Samples: %i", this->sample_count_);
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "  Sampling mode: %s", LOG_STR_ARG(sampling_mode_to_str(this->sampling_mode_)));
 | 
			
		||||
  LOG_UPDATE_INTERVAL(this);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
float ADCSensor::sample() {
 | 
			
		||||
  uint32_t raw = 0;
 | 
			
		||||
  auto aggr = Aggregator(this->sampling_mode_);
 | 
			
		||||
 | 
			
		||||
  if (this->is_temperature_) {
 | 
			
		||||
    adc_set_temp_sensor_enabled(true);
 | 
			
		||||
    delay(1);
 | 
			
		||||
    adc_select_input(4);
 | 
			
		||||
 | 
			
		||||
    for (uint8_t sample = 0; sample < this->sample_count_; sample++) {
 | 
			
		||||
      raw = adc_read();
 | 
			
		||||
      aggr.add_sample(raw);
 | 
			
		||||
    }
 | 
			
		||||
    adc_set_temp_sensor_enabled(false);
 | 
			
		||||
    if (this->output_raw_) {
 | 
			
		||||
      return aggr.aggregate();
 | 
			
		||||
    }
 | 
			
		||||
    return aggr.aggregate() * 3.3f / 4096.0f;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  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);
 | 
			
		||||
 | 
			
		||||
  for (uint8_t sample = 0; sample < this->sample_count_; sample++) {
 | 
			
		||||
    raw = adc_read();
 | 
			
		||||
    aggr.add_sample(raw);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
#ifdef CYW43_USES_VSYS_PIN
 | 
			
		||||
  if (pin == PICO_VSYS_PIN) {
 | 
			
		||||
    cyw43_thread_exit();
 | 
			
		||||
  }
 | 
			
		||||
#endif  // CYW43_USES_VSYS_PIN
 | 
			
		||||
 | 
			
		||||
  if (this->output_raw_) {
 | 
			
		||||
    return aggr.aggregate();
 | 
			
		||||
  }
 | 
			
		||||
  float coeff = pin == PICO_VSYS_PIN ? 3.0f : 1.0f;
 | 
			
		||||
  return aggr.aggregate() * 3.3f / 4096.0f * coeff;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
}  // namespace adc
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
 | 
			
		||||
#endif  // USE_RP2040
 | 
			
		||||
@@ -1,9 +1,11 @@
 | 
			
		||||
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
 | 
			
		||||
import esphome.config_validation as cv
 | 
			
		||||
from esphome.const import (
 | 
			
		||||
    CONF_ATTENUATION,
 | 
			
		||||
    CONF_ID,
 | 
			
		||||
@@ -15,14 +17,10 @@ from esphome.const import (
 | 
			
		||||
    STATE_CLASS_MEASUREMENT,
 | 
			
		||||
    UNIT_VOLT,
 | 
			
		||||
)
 | 
			
		||||
from esphome.core import CORE
 | 
			
		||||
import esphome.final_validate as fv
 | 
			
		||||
 | 
			
		||||
from . import (
 | 
			
		||||
    ATTENUATION_MODES,
 | 
			
		||||
    ESP32_VARIANT_ADC1_PIN_TO_CHANNEL,
 | 
			
		||||
    ESP32_VARIANT_ADC2_PIN_TO_CHANNEL,
 | 
			
		||||
    SAMPLING_MODES,
 | 
			
		||||
    adc_ns,
 | 
			
		||||
    validate_adc_pin,
 | 
			
		||||
)
 | 
			
		||||
@@ -32,11 +30,9 @@ _LOGGER = logging.getLogger(__name__)
 | 
			
		||||
AUTO_LOAD = ["voltage_sampler"]
 | 
			
		||||
 | 
			
		||||
CONF_SAMPLES = "samples"
 | 
			
		||||
CONF_SAMPLING_MODE = "sampling_mode"
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
_attenuation = cv.enum(ATTENUATION_MODES, lower=True)
 | 
			
		||||
_sampling_mode = cv.enum(SAMPLING_MODES, lower=True)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
def validate_config(config):
 | 
			
		||||
@@ -92,7 +88,6 @@ CONFIG_SCHEMA = cv.All(
 | 
			
		||||
                cv.only_on_esp32, _attenuation
 | 
			
		||||
            ),
 | 
			
		||||
            cv.Optional(CONF_SAMPLES, default=1): cv.int_range(min=1, max=255),
 | 
			
		||||
            cv.Optional(CONF_SAMPLING_MODE, default="avg"): _sampling_mode,
 | 
			
		||||
        }
 | 
			
		||||
    )
 | 
			
		||||
    .extend(cv.polling_component_schema("60s")),
 | 
			
		||||
@@ -117,7 +112,6 @@ async def to_code(config):
 | 
			
		||||
 | 
			
		||||
    cg.add(var.set_output_raw(config[CONF_RAW]))
 | 
			
		||||
    cg.add(var.set_sample_count(config[CONF_SAMPLES]))
 | 
			
		||||
    cg.add(var.set_sampling_mode(config[CONF_SAMPLING_MODE]))
 | 
			
		||||
 | 
			
		||||
    if attenuation := config.get(CONF_ATTENUATION):
 | 
			
		||||
        if attenuation == "auto":
 | 
			
		||||
 
 | 
			
		||||
@@ -9,6 +9,8 @@ static const char *const TAG = "ads1115";
 | 
			
		||||
static const uint8_t ADS1115_REGISTER_CONVERSION = 0x00;
 | 
			
		||||
static const uint8_t ADS1115_REGISTER_CONFIG = 0x01;
 | 
			
		||||
 | 
			
		||||
static const uint8_t ADS1115_DATA_RATE_860_SPS = 0b111;  // 3300_SPS for ADS1015
 | 
			
		||||
 | 
			
		||||
void ADS1115Component::setup() {
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "Setting up ADS1115...");
 | 
			
		||||
  uint16_t value;
 | 
			
		||||
@@ -41,9 +43,9 @@ void ADS1115Component::setup() {
 | 
			
		||||
    config |= 0b0000000100000000;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // Set data rate - 860 samples per second
 | 
			
		||||
  // Set data rate - 860 samples per second (we're in singleshot mode)
 | 
			
		||||
  //        0bxxxxxxxx100xxxxx
 | 
			
		||||
  config |= ADS1115_860SPS << 5;
 | 
			
		||||
  config |= ADS1115_DATA_RATE_860_SPS << 5;
 | 
			
		||||
 | 
			
		||||
  // Set comparator mode - hysteresis
 | 
			
		||||
  //        0bxxxxxxxxxxx0xxxx
 | 
			
		||||
@@ -75,7 +77,7 @@ void ADS1115Component::dump_config() {
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
float ADS1115Component::request_measurement(ADS1115Multiplexer multiplexer, ADS1115Gain gain,
 | 
			
		||||
                                            ADS1115Resolution resolution, ADS1115Samplerate samplerate) {
 | 
			
		||||
                                            ADS1115Resolution resolution) {
 | 
			
		||||
  uint16_t config = this->prev_config_;
 | 
			
		||||
  // Multiplexer
 | 
			
		||||
  //        0bxBBBxxxxxxxxxxxx
 | 
			
		||||
@@ -87,11 +89,6 @@ float ADS1115Component::request_measurement(ADS1115Multiplexer multiplexer, ADS1
 | 
			
		||||
  config &= 0b1111000111111111;
 | 
			
		||||
  config |= (gain & 0b111) << 9;
 | 
			
		||||
 | 
			
		||||
  // Sample rate
 | 
			
		||||
  //        0bxxxxxxxxBBBxxxxx
 | 
			
		||||
  config &= 0b1111111100011111;
 | 
			
		||||
  config |= (samplerate & 0b111) << 5;
 | 
			
		||||
 | 
			
		||||
  if (!this->continuous_mode_) {
 | 
			
		||||
    // Start conversion
 | 
			
		||||
    config |= 0b1000000000000000;
 | 
			
		||||
@@ -104,54 +101,8 @@ float ADS1115Component::request_measurement(ADS1115Multiplexer multiplexer, ADS1
 | 
			
		||||
    }
 | 
			
		||||
    this->prev_config_ = config;
 | 
			
		||||
 | 
			
		||||
    // Delay calculated as: ceil((1000/SPS)+.5)
 | 
			
		||||
    if (resolution == ADS1015_12_BITS) {
 | 
			
		||||
      switch (samplerate) {
 | 
			
		||||
        case ADS1115_8SPS:
 | 
			
		||||
          delay(9);
 | 
			
		||||
          break;
 | 
			
		||||
        case ADS1115_16SPS:
 | 
			
		||||
          delay(5);
 | 
			
		||||
          break;
 | 
			
		||||
        case ADS1115_32SPS:
 | 
			
		||||
          delay(3);
 | 
			
		||||
          break;
 | 
			
		||||
        case ADS1115_64SPS:
 | 
			
		||||
        case ADS1115_128SPS:
 | 
			
		||||
          delay(2);
 | 
			
		||||
          break;
 | 
			
		||||
        default:
 | 
			
		||||
          delay(1);
 | 
			
		||||
          break;
 | 
			
		||||
      }
 | 
			
		||||
    } else {
 | 
			
		||||
      switch (samplerate) {
 | 
			
		||||
        case ADS1115_8SPS:
 | 
			
		||||
          delay(126);  // NOLINT
 | 
			
		||||
          break;
 | 
			
		||||
        case ADS1115_16SPS:
 | 
			
		||||
          delay(63);  // NOLINT
 | 
			
		||||
          break;
 | 
			
		||||
        case ADS1115_32SPS:
 | 
			
		||||
          delay(32);
 | 
			
		||||
          break;
 | 
			
		||||
        case ADS1115_64SPS:
 | 
			
		||||
          delay(17);
 | 
			
		||||
          break;
 | 
			
		||||
        case ADS1115_128SPS:
 | 
			
		||||
          delay(9);
 | 
			
		||||
          break;
 | 
			
		||||
        case ADS1115_250SPS:
 | 
			
		||||
          delay(5);
 | 
			
		||||
          break;
 | 
			
		||||
        case ADS1115_475SPS:
 | 
			
		||||
          delay(3);
 | 
			
		||||
          break;
 | 
			
		||||
        case ADS1115_860SPS:
 | 
			
		||||
          delay(2);
 | 
			
		||||
          break;
 | 
			
		||||
      }
 | 
			
		||||
    }
 | 
			
		||||
    // about 1.2 ms with 860 samples per second
 | 
			
		||||
    delay(2);
 | 
			
		||||
 | 
			
		||||
    // in continuous mode, conversion will always be running, rely on the delay
 | 
			
		||||
    // to ensure conversion is taking place with the correct settings
 | 
			
		||||
 
 | 
			
		||||
@@ -33,17 +33,6 @@ enum ADS1115Resolution {
 | 
			
		||||
  ADS1015_12_BITS = 12,
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
enum ADS1115Samplerate {
 | 
			
		||||
  ADS1115_8SPS = 0b000,
 | 
			
		||||
  ADS1115_16SPS = 0b001,
 | 
			
		||||
  ADS1115_32SPS = 0b010,
 | 
			
		||||
  ADS1115_64SPS = 0b011,
 | 
			
		||||
  ADS1115_128SPS = 0b100,
 | 
			
		||||
  ADS1115_250SPS = 0b101,
 | 
			
		||||
  ADS1115_475SPS = 0b110,
 | 
			
		||||
  ADS1115_860SPS = 0b111
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
class ADS1115Component : public Component, public i2c::I2CDevice {
 | 
			
		||||
 public:
 | 
			
		||||
  void setup() override;
 | 
			
		||||
@@ -53,8 +42,7 @@ 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(ADS1115Multiplexer multiplexer, ADS1115Gain gain, ADS1115Resolution resolution,
 | 
			
		||||
                            ADS1115Samplerate samplerate);
 | 
			
		||||
  float request_measurement(ADS1115Multiplexer multiplexer, ADS1115Gain gain, ADS1115Resolution resolution);
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  uint16_t prev_config_{0};
 | 
			
		||||
 
 | 
			
		||||
@@ -5,7 +5,6 @@ from esphome.const import (
 | 
			
		||||
    CONF_GAIN,
 | 
			
		||||
    CONF_MULTIPLEXER,
 | 
			
		||||
    CONF_RESOLUTION,
 | 
			
		||||
    CONF_SAMPLE_RATE,
 | 
			
		||||
    DEVICE_CLASS_VOLTAGE,
 | 
			
		||||
    STATE_CLASS_MEASUREMENT,
 | 
			
		||||
    UNIT_VOLT,
 | 
			
		||||
@@ -44,17 +43,6 @@ RESOLUTION = {
 | 
			
		||||
    "12_BITS": ADS1115Resolution.ADS1015_12_BITS,
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
ADS1115Samplerate = ads1115_ns.enum("ADS1115Samplerate")
 | 
			
		||||
SAMPLERATE = {
 | 
			
		||||
    "8": ADS1115Samplerate.ADS1115_8SPS,
 | 
			
		||||
    "16": ADS1115Samplerate.ADS1115_16SPS,
 | 
			
		||||
    "32": ADS1115Samplerate.ADS1115_32SPS,
 | 
			
		||||
    "64": ADS1115Samplerate.ADS1115_64SPS,
 | 
			
		||||
    "128": ADS1115Samplerate.ADS1115_128SPS,
 | 
			
		||||
    "250": ADS1115Samplerate.ADS1115_250SPS,
 | 
			
		||||
    "475": ADS1115Samplerate.ADS1115_475SPS,
 | 
			
		||||
    "860": ADS1115Samplerate.ADS1115_860SPS,
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
ADS1115Sensor = ads1115_ns.class_(
 | 
			
		||||
    "ADS1115Sensor", sensor.Sensor, cg.PollingComponent, voltage_sampler.VoltageSampler
 | 
			
		||||
@@ -76,9 +64,6 @@ CONFIG_SCHEMA = (
 | 
			
		||||
            cv.Optional(CONF_RESOLUTION, default="16_BITS"): cv.enum(
 | 
			
		||||
                RESOLUTION, upper=True, space="_"
 | 
			
		||||
            ),
 | 
			
		||||
            cv.Optional(CONF_SAMPLE_RATE, default="860"): cv.enum(
 | 
			
		||||
                SAMPLERATE, string=True
 | 
			
		||||
            ),
 | 
			
		||||
        }
 | 
			
		||||
    )
 | 
			
		||||
    .extend(cv.polling_component_schema("60s"))
 | 
			
		||||
@@ -94,4 +79,3 @@ async def to_code(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(var.set_samplerate(config[CONF_SAMPLE_RATE]))
 | 
			
		||||
 
 | 
			
		||||
@@ -8,7 +8,7 @@ namespace ads1115 {
 | 
			
		||||
static const char *const TAG = "ads1115.sensor";
 | 
			
		||||
 | 
			
		||||
float ADS1115Sensor::sample() {
 | 
			
		||||
  return this->parent_->request_measurement(this->multiplexer_, this->gain_, this->resolution_, this->samplerate_);
 | 
			
		||||
  return this->parent_->request_measurement(this->multiplexer_, this->gain_, this->resolution_);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void ADS1115Sensor::update() {
 | 
			
		||||
@@ -24,7 +24,6 @@ void ADS1115Sensor::dump_config() {
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "    Multiplexer: %u", this->multiplexer_);
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "    Gain: %u", this->gain_);
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "    Resolution: %u", this->resolution_);
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "    Sample rate: %u", this->samplerate_);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
}  // namespace ads1115
 | 
			
		||||
 
 | 
			
		||||
@@ -21,7 +21,6 @@ class ADS1115Sensor : public sensor::Sensor,
 | 
			
		||||
  void set_multiplexer(ADS1115Multiplexer multiplexer) { this->multiplexer_ = multiplexer; }
 | 
			
		||||
  void set_gain(ADS1115Gain gain) { this->gain_ = gain; }
 | 
			
		||||
  void set_resolution(ADS1115Resolution resolution) { this->resolution_ = resolution; }
 | 
			
		||||
  void set_samplerate(ADS1115Samplerate samplerate) { this->samplerate_ = samplerate; }
 | 
			
		||||
  float sample() override;
 | 
			
		||||
 | 
			
		||||
  void dump_config() override;
 | 
			
		||||
@@ -30,7 +29,6 @@ class ADS1115Sensor : public sensor::Sensor,
 | 
			
		||||
  ADS1115Multiplexer multiplexer_;
 | 
			
		||||
  ADS1115Gain gain_;
 | 
			
		||||
  ADS1115Resolution resolution_;
 | 
			
		||||
  ADS1115Samplerate samplerate_;
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
}  // namespace ads1115
 | 
			
		||||
 
 | 
			
		||||
@@ -1,173 +0,0 @@
 | 
			
		||||
#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<float>(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<int8_t>(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
 | 
			
		||||
@@ -1,88 +0,0 @@
 | 
			
		||||
#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
 | 
			
		||||
@@ -1,52 +0,0 @@
 | 
			
		||||
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)
 | 
			
		||||
@@ -1,23 +0,0 @@
 | 
			
		||||
#pragma once
 | 
			
		||||
 | 
			
		||||
#include "esphome/core/automation.h"
 | 
			
		||||
#include "esphome/core/component.h"
 | 
			
		||||
#include "aic3204.h"
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace aic3204 {
 | 
			
		||||
 | 
			
		||||
template<typename... Ts> class SetAutoMuteAction : public Action<Ts...> {
 | 
			
		||||
 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
 | 
			
		||||
@@ -9,7 +9,7 @@ from esphome.const import (
 | 
			
		||||
    CONF_MQTT_ID,
 | 
			
		||||
    CONF_ON_STATE,
 | 
			
		||||
    CONF_TRIGGER_ID,
 | 
			
		||||
    CONF_WEB_SERVER,
 | 
			
		||||
    CONF_WEB_SERVER_ID,
 | 
			
		||||
)
 | 
			
		||||
from esphome.core import CORE, coroutine_with_priority
 | 
			
		||||
from esphome.cpp_helpers import setup_entity
 | 
			
		||||
@@ -195,8 +195,9 @@ async def setup_alarm_control_panel_core_(var, config):
 | 
			
		||||
    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 (webserver_id := config.get(CONF_WEB_SERVER_ID)) is not None:
 | 
			
		||||
        web_server_ = await cg.get_variable(webserver_id)
 | 
			
		||||
        web_server.add_entity_to_sorting_list(web_server_, var, config)
 | 
			
		||||
    if mqtt_id := config.get(CONF_MQTT_ID):
 | 
			
		||||
        mqtt_ = cg.new_Pvariable(mqtt_id, var)
 | 
			
		||||
        await mqtt.register_mqtt_component(mqtt_, config)
 | 
			
		||||
 
 | 
			
		||||
@@ -72,9 +72,10 @@ void AlarmControlPanelCall::validate_() {
 | 
			
		||||
      this->state_.reset();
 | 
			
		||||
      return;
 | 
			
		||||
    }
 | 
			
		||||
    if (state == ACP_STATE_DISARMED && !this->parent_->is_state_armed(this->parent_->get_state()) &&
 | 
			
		||||
        this->parent_->get_state() != ACP_STATE_PENDING && this->parent_->get_state() != ACP_STATE_ARMING &&
 | 
			
		||||
        this->parent_->get_state() != ACP_STATE_TRIGGERED) {
 | 
			
		||||
    if (state == ACP_STATE_DISARMED &&
 | 
			
		||||
        !(this->parent_->is_state_armed(this->parent_->get_state()) ||
 | 
			
		||||
          this->parent_->get_state() == ACP_STATE_PENDING || this->parent_->get_state() == ACP_STATE_ARMING ||
 | 
			
		||||
          this->parent_->get_state() == ACP_STATE_TRIGGERED)) {
 | 
			
		||||
      ESP_LOGW(TAG, "Cannot disarm when not armed");
 | 
			
		||||
      this->state_.reset();
 | 
			
		||||
      return;
 | 
			
		||||
 
 | 
			
		||||
@@ -1,10 +1,29 @@
 | 
			
		||||
import logging
 | 
			
		||||
 | 
			
		||||
from esphome import automation
 | 
			
		||||
import esphome.codegen as cg
 | 
			
		||||
from esphome import automation, core
 | 
			
		||||
from esphome.components import font
 | 
			
		||||
import esphome.components.image as espImage
 | 
			
		||||
from esphome.components.image import (
 | 
			
		||||
    CONF_USE_TRANSPARENCY,
 | 
			
		||||
    LOCAL_SCHEMA,
 | 
			
		||||
    WEB_SCHEMA,
 | 
			
		||||
    SOURCE_WEB,
 | 
			
		||||
    SOURCE_LOCAL,
 | 
			
		||||
)
 | 
			
		||||
import esphome.config_validation as cv
 | 
			
		||||
from esphome.const import CONF_ID, CONF_REPEAT
 | 
			
		||||
import esphome.codegen as cg
 | 
			
		||||
from esphome.const import (
 | 
			
		||||
    CONF_FILE,
 | 
			
		||||
    CONF_ID,
 | 
			
		||||
    CONF_RAW_DATA_ID,
 | 
			
		||||
    CONF_REPEAT,
 | 
			
		||||
    CONF_RESIZE,
 | 
			
		||||
    CONF_TYPE,
 | 
			
		||||
    CONF_SOURCE,
 | 
			
		||||
    CONF_PATH,
 | 
			
		||||
    CONF_URL,
 | 
			
		||||
)
 | 
			
		||||
from esphome.core import CORE, HexInt
 | 
			
		||||
 | 
			
		||||
_LOGGER = logging.getLogger(__name__)
 | 
			
		||||
 | 
			
		||||
@@ -12,7 +31,6 @@ AUTO_LOAD = ["image"]
 | 
			
		||||
CODEOWNERS = ["@syndlex"]
 | 
			
		||||
DEPENDENCIES = ["display"]
 | 
			
		||||
MULTI_CONF = True
 | 
			
		||||
MULTI_CONF_NO_DEFAULT = True
 | 
			
		||||
 | 
			
		||||
CONF_LOOP = "loop"
 | 
			
		||||
CONF_START_FRAME = "start_frame"
 | 
			
		||||
@@ -34,20 +52,87 @@ SetFrameAction = animation_ns.class_(
 | 
			
		||||
    "AnimationSetFrameAction", automation.Action, cg.Parented.template(Animation_)
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
CONFIG_SCHEMA = espImage.IMAGE_SCHEMA.extend(
 | 
			
		||||
TYPED_FILE_SCHEMA = cv.typed_schema(
 | 
			
		||||
    {
 | 
			
		||||
        cv.Required(CONF_ID): cv.declare_id(Animation_),
 | 
			
		||||
        cv.Optional(CONF_LOOP): cv.All(
 | 
			
		||||
            {
 | 
			
		||||
                cv.Optional(CONF_START_FRAME, default=0): cv.positive_int,
 | 
			
		||||
                cv.Optional(CONF_END_FRAME): cv.positive_int,
 | 
			
		||||
                cv.Optional(CONF_REPEAT): cv.positive_int,
 | 
			
		||||
            }
 | 
			
		||||
        ),
 | 
			
		||||
        SOURCE_LOCAL: LOCAL_SCHEMA,
 | 
			
		||||
        SOURCE_WEB: WEB_SCHEMA,
 | 
			
		||||
    },
 | 
			
		||||
    key=CONF_SOURCE,
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
def _file_schema(value):
 | 
			
		||||
    if isinstance(value, str):
 | 
			
		||||
        return validate_file_shorthand(value)
 | 
			
		||||
    return TYPED_FILE_SCHEMA(value)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
FILE_SCHEMA = cv.Schema(_file_schema)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
def validate_file_shorthand(value):
 | 
			
		||||
    value = cv.string_strict(value)
 | 
			
		||||
    if value.startswith("http://") or value.startswith("https://"):
 | 
			
		||||
        return FILE_SCHEMA(
 | 
			
		||||
            {
 | 
			
		||||
                CONF_SOURCE: SOURCE_WEB,
 | 
			
		||||
                CONF_URL: value,
 | 
			
		||||
            }
 | 
			
		||||
        )
 | 
			
		||||
    return FILE_SCHEMA(
 | 
			
		||||
        {
 | 
			
		||||
            CONF_SOURCE: SOURCE_LOCAL,
 | 
			
		||||
            CONF_PATH: value,
 | 
			
		||||
        }
 | 
			
		||||
    )
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
def validate_cross_dependencies(config):
 | 
			
		||||
    """
 | 
			
		||||
    Validate fields whose possible values depend on other fields.
 | 
			
		||||
    For example, validate that explicitly transparent image types
 | 
			
		||||
    have "use_transparency" set to True.
 | 
			
		||||
    Also set the default value for those kind of dependent fields.
 | 
			
		||||
    """
 | 
			
		||||
    image_type = config[CONF_TYPE]
 | 
			
		||||
    is_transparent_type = image_type in ["TRANSPARENT_BINARY", "RGBA"]
 | 
			
		||||
    # If the use_transparency option was not specified, set the default depending on the image type
 | 
			
		||||
    if CONF_USE_TRANSPARENCY not in config:
 | 
			
		||||
        config[CONF_USE_TRANSPARENCY] = is_transparent_type
 | 
			
		||||
 | 
			
		||||
    if is_transparent_type and not config[CONF_USE_TRANSPARENCY]:
 | 
			
		||||
        raise cv.Invalid(f"Image type {image_type} must always be transparent.")
 | 
			
		||||
 | 
			
		||||
    return config
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
ANIMATION_SCHEMA = cv.Schema(
 | 
			
		||||
    cv.All(
 | 
			
		||||
        {
 | 
			
		||||
            cv.Required(CONF_ID): cv.declare_id(Animation_),
 | 
			
		||||
            cv.Required(CONF_FILE): FILE_SCHEMA,
 | 
			
		||||
            cv.Optional(CONF_RESIZE): cv.dimensions,
 | 
			
		||||
            cv.Optional(CONF_TYPE, default="BINARY"): cv.enum(
 | 
			
		||||
                espImage.IMAGE_TYPE, upper=True
 | 
			
		||||
            ),
 | 
			
		||||
            # Not setting default here on purpose; the default depends on the image type,
 | 
			
		||||
            # and thus will be set in the "validate_cross_dependencies" validator.
 | 
			
		||||
            cv.Optional(CONF_USE_TRANSPARENCY): cv.boolean,
 | 
			
		||||
            cv.Optional(CONF_LOOP): cv.All(
 | 
			
		||||
                {
 | 
			
		||||
                    cv.Optional(CONF_START_FRAME, default=0): cv.positive_int,
 | 
			
		||||
                    cv.Optional(CONF_END_FRAME): cv.positive_int,
 | 
			
		||||
                    cv.Optional(CONF_REPEAT): cv.positive_int,
 | 
			
		||||
                }
 | 
			
		||||
            ),
 | 
			
		||||
            cv.GenerateID(CONF_RAW_DATA_ID): cv.declare_id(cg.uint8),
 | 
			
		||||
        },
 | 
			
		||||
        validate_cross_dependencies,
 | 
			
		||||
    )
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
CONFIG_SCHEMA = cv.All(font.validate_pillow_installed, ANIMATION_SCHEMA)
 | 
			
		||||
 | 
			
		||||
NEXT_FRAME_SCHEMA = automation.maybe_simple_id(
 | 
			
		||||
    {
 | 
			
		||||
        cv.GenerateID(): cv.use_id(Animation_),
 | 
			
		||||
@@ -80,26 +165,179 @@ async def animation_action_to_code(config, action_id, template_arg, args):
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
async def to_code(config):
 | 
			
		||||
    (
 | 
			
		||||
        prog_arr,
 | 
			
		||||
        width,
 | 
			
		||||
        height,
 | 
			
		||||
        image_type,
 | 
			
		||||
        trans_value,
 | 
			
		||||
        frame_count,
 | 
			
		||||
    ) = await espImage.write_image(config, all_frames=True)
 | 
			
		||||
    from PIL import Image
 | 
			
		||||
 | 
			
		||||
    conf_file = config[CONF_FILE]
 | 
			
		||||
    if conf_file[CONF_SOURCE] == SOURCE_LOCAL:
 | 
			
		||||
        path = CORE.relative_config_path(conf_file[CONF_PATH])
 | 
			
		||||
    elif conf_file[CONF_SOURCE] == SOURCE_WEB:
 | 
			
		||||
        path = espImage.compute_local_image_path(conf_file).as_posix()
 | 
			
		||||
    try:
 | 
			
		||||
        image = Image.open(path)
 | 
			
		||||
    except Exception as e:
 | 
			
		||||
        raise core.EsphomeError(f"Could not load image file {path}: {e}")
 | 
			
		||||
 | 
			
		||||
    width, height = image.size
 | 
			
		||||
    frames = image.n_frames
 | 
			
		||||
    if CONF_RESIZE in config:
 | 
			
		||||
        new_width_max, new_height_max = config[CONF_RESIZE]
 | 
			
		||||
        ratio = min(new_width_max / width, new_height_max / height)
 | 
			
		||||
        width, height = int(width * ratio), int(height * ratio)
 | 
			
		||||
    else:
 | 
			
		||||
        if width > 500 or height > 500:
 | 
			
		||||
            _LOGGER.warning(
 | 
			
		||||
                'The image "%s" you requested is very big. Please consider'
 | 
			
		||||
                " using the resize parameter.",
 | 
			
		||||
                path,
 | 
			
		||||
            )
 | 
			
		||||
 | 
			
		||||
    transparent = config[CONF_USE_TRANSPARENCY]
 | 
			
		||||
 | 
			
		||||
    if config[CONF_TYPE] == "GRAYSCALE":
 | 
			
		||||
        data = [0 for _ in range(height * width * frames)]
 | 
			
		||||
        pos = 0
 | 
			
		||||
        for frameIndex in range(frames):
 | 
			
		||||
            image.seek(frameIndex)
 | 
			
		||||
            frame = image.convert("LA", dither=Image.Dither.NONE)
 | 
			
		||||
            if CONF_RESIZE in config:
 | 
			
		||||
                frame = frame.resize([width, height])
 | 
			
		||||
            pixels = list(frame.getdata())
 | 
			
		||||
            if len(pixels) != height * width:
 | 
			
		||||
                raise core.EsphomeError(
 | 
			
		||||
                    f"Unexpected number of pixels in {path} frame {frameIndex}: ({len(pixels)} != {height * width})"
 | 
			
		||||
                )
 | 
			
		||||
            for pix, a in pixels:
 | 
			
		||||
                if transparent:
 | 
			
		||||
                    if pix == 1:
 | 
			
		||||
                        pix = 0
 | 
			
		||||
                    if a < 0x80:
 | 
			
		||||
                        pix = 1
 | 
			
		||||
 | 
			
		||||
                data[pos] = pix
 | 
			
		||||
                pos += 1
 | 
			
		||||
 | 
			
		||||
    elif config[CONF_TYPE] == "RGBA":
 | 
			
		||||
        data = [0 for _ in range(height * width * 4 * frames)]
 | 
			
		||||
        pos = 0
 | 
			
		||||
        for frameIndex in range(frames):
 | 
			
		||||
            image.seek(frameIndex)
 | 
			
		||||
            frame = image.convert("RGBA")
 | 
			
		||||
            if CONF_RESIZE in config:
 | 
			
		||||
                frame = frame.resize([width, height])
 | 
			
		||||
            pixels = list(frame.getdata())
 | 
			
		||||
            if len(pixels) != height * width:
 | 
			
		||||
                raise core.EsphomeError(
 | 
			
		||||
                    f"Unexpected number of pixels in {path} frame {frameIndex}: ({len(pixels)} != {height * width})"
 | 
			
		||||
                )
 | 
			
		||||
            for pix in pixels:
 | 
			
		||||
                data[pos] = pix[0]
 | 
			
		||||
                pos += 1
 | 
			
		||||
                data[pos] = pix[1]
 | 
			
		||||
                pos += 1
 | 
			
		||||
                data[pos] = pix[2]
 | 
			
		||||
                pos += 1
 | 
			
		||||
                data[pos] = pix[3]
 | 
			
		||||
                pos += 1
 | 
			
		||||
 | 
			
		||||
    elif config[CONF_TYPE] == "RGB24":
 | 
			
		||||
        data = [0 for _ in range(height * width * 3 * frames)]
 | 
			
		||||
        pos = 0
 | 
			
		||||
        for frameIndex in range(frames):
 | 
			
		||||
            image.seek(frameIndex)
 | 
			
		||||
            frame = image.convert("RGBA")
 | 
			
		||||
            if CONF_RESIZE in config:
 | 
			
		||||
                frame = frame.resize([width, height])
 | 
			
		||||
            pixels = list(frame.getdata())
 | 
			
		||||
            if len(pixels) != height * width:
 | 
			
		||||
                raise core.EsphomeError(
 | 
			
		||||
                    f"Unexpected number of pixels in {path} frame {frameIndex}: ({len(pixels)} != {height * width})"
 | 
			
		||||
                )
 | 
			
		||||
            for r, g, b, a in pixels:
 | 
			
		||||
                if transparent:
 | 
			
		||||
                    if r == 0 and g == 0 and b == 1:
 | 
			
		||||
                        b = 0
 | 
			
		||||
                    if a < 0x80:
 | 
			
		||||
                        r = 0
 | 
			
		||||
                        g = 0
 | 
			
		||||
                        b = 1
 | 
			
		||||
 | 
			
		||||
                data[pos] = r
 | 
			
		||||
                pos += 1
 | 
			
		||||
                data[pos] = g
 | 
			
		||||
                pos += 1
 | 
			
		||||
                data[pos] = b
 | 
			
		||||
                pos += 1
 | 
			
		||||
 | 
			
		||||
    elif config[CONF_TYPE] in ["RGB565", "TRANSPARENT_IMAGE"]:
 | 
			
		||||
        data = [0 for _ in range(height * width * 2 * frames)]
 | 
			
		||||
        pos = 0
 | 
			
		||||
        for frameIndex in range(frames):
 | 
			
		||||
            image.seek(frameIndex)
 | 
			
		||||
            frame = image.convert("RGBA")
 | 
			
		||||
            if CONF_RESIZE in config:
 | 
			
		||||
                frame = frame.resize([width, height])
 | 
			
		||||
            pixels = list(frame.getdata())
 | 
			
		||||
            if len(pixels) != height * width:
 | 
			
		||||
                raise core.EsphomeError(
 | 
			
		||||
                    f"Unexpected number of pixels in {path} frame {frameIndex}: ({len(pixels)} != {height * width})"
 | 
			
		||||
                )
 | 
			
		||||
            for r, g, b, a in pixels:
 | 
			
		||||
                R = r >> 3
 | 
			
		||||
                G = g >> 2
 | 
			
		||||
                B = b >> 3
 | 
			
		||||
                rgb = (R << 11) | (G << 5) | B
 | 
			
		||||
 | 
			
		||||
                if transparent:
 | 
			
		||||
                    if rgb == 0x0020:
 | 
			
		||||
                        rgb = 0
 | 
			
		||||
                    if a < 0x80:
 | 
			
		||||
                        rgb = 0x0020
 | 
			
		||||
 | 
			
		||||
                data[pos] = rgb >> 8
 | 
			
		||||
                pos += 1
 | 
			
		||||
                data[pos] = rgb & 0xFF
 | 
			
		||||
                pos += 1
 | 
			
		||||
 | 
			
		||||
    elif config[CONF_TYPE] in ["BINARY", "TRANSPARENT_BINARY"]:
 | 
			
		||||
        width8 = ((width + 7) // 8) * 8
 | 
			
		||||
        data = [0 for _ in range((height * width8 // 8) * frames)]
 | 
			
		||||
        for frameIndex in range(frames):
 | 
			
		||||
            image.seek(frameIndex)
 | 
			
		||||
            if transparent:
 | 
			
		||||
                alpha = image.split()[-1]
 | 
			
		||||
                has_alpha = alpha.getextrema()[0] < 0xFF
 | 
			
		||||
            frame = image.convert("1", dither=Image.Dither.NONE)
 | 
			
		||||
            if CONF_RESIZE in config:
 | 
			
		||||
                frame = frame.resize([width, height])
 | 
			
		||||
                if transparent:
 | 
			
		||||
                    alpha = alpha.resize([width, height])
 | 
			
		||||
            for x, y in [(i, j) for i in range(width) for j in range(height)]:
 | 
			
		||||
                if transparent and has_alpha:
 | 
			
		||||
                    if not alpha.getpixel((x, y)):
 | 
			
		||||
                        continue
 | 
			
		||||
                elif frame.getpixel((x, y)):
 | 
			
		||||
                    continue
 | 
			
		||||
 | 
			
		||||
                pos = x + y * width8 + (height * width8 * frameIndex)
 | 
			
		||||
                data[pos // 8] |= 0x80 >> (pos % 8)
 | 
			
		||||
    else:
 | 
			
		||||
        raise core.EsphomeError(
 | 
			
		||||
            f"Animation f{config[CONF_ID]} has not supported type {config[CONF_TYPE]}."
 | 
			
		||||
        )
 | 
			
		||||
 | 
			
		||||
    rhs = [HexInt(x) for x in data]
 | 
			
		||||
    prog_arr = cg.progmem_array(config[CONF_RAW_DATA_ID], rhs)
 | 
			
		||||
    var = cg.new_Pvariable(
 | 
			
		||||
        config[CONF_ID],
 | 
			
		||||
        prog_arr,
 | 
			
		||||
        width,
 | 
			
		||||
        height,
 | 
			
		||||
        frame_count,
 | 
			
		||||
        image_type,
 | 
			
		||||
        trans_value,
 | 
			
		||||
        frames,
 | 
			
		||||
        espImage.IMAGE_TYPE[config[CONF_TYPE]],
 | 
			
		||||
    )
 | 
			
		||||
    cg.add(var.set_transparency(transparent))
 | 
			
		||||
    if loop_config := config.get(CONF_LOOP):
 | 
			
		||||
        start = loop_config[CONF_START_FRAME]
 | 
			
		||||
        end = loop_config.get(CONF_END_FRAME, frame_count)
 | 
			
		||||
        end = loop_config.get(CONF_END_FRAME, frames)
 | 
			
		||||
        count = loop_config.get(CONF_REPEAT, -1)
 | 
			
		||||
        cg.add(var.set_loop(start, end, count))
 | 
			
		||||
 
 | 
			
		||||
@@ -6,8 +6,8 @@ namespace esphome {
 | 
			
		||||
namespace animation {
 | 
			
		||||
 | 
			
		||||
Animation::Animation(const uint8_t *data_start, int width, int height, uint32_t animation_frame_count,
 | 
			
		||||
                     image::ImageType type, image::Transparency transparent)
 | 
			
		||||
    : Image(data_start, width, height, type, transparent),
 | 
			
		||||
                     image::ImageType type)
 | 
			
		||||
    : Image(data_start, width, height, type),
 | 
			
		||||
      animation_data_start_(data_start),
 | 
			
		||||
      current_frame_(0),
 | 
			
		||||
      animation_frame_count_(animation_frame_count),
 | 
			
		||||
@@ -62,7 +62,7 @@ void Animation::set_frame(int frame) {
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void Animation::update_data_start_() {
 | 
			
		||||
  const uint32_t image_size = this->get_width_stride() * this->height_;
 | 
			
		||||
  const uint32_t image_size = image_type_to_width_stride(this->width_, this->type_) * this->height_;
 | 
			
		||||
  this->data_start_ = this->animation_data_start_ + image_size * this->current_frame_;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -8,8 +8,7 @@ namespace animation {
 | 
			
		||||
 | 
			
		||||
class Animation : public image::Image {
 | 
			
		||||
 public:
 | 
			
		||||
  Animation(const uint8_t *data_start, int width, int height, uint32_t animation_frame_count, image::ImageType type,
 | 
			
		||||
            image::Transparency transparent);
 | 
			
		||||
  Animation(const uint8_t *data_start, int width, int height, uint32_t animation_frame_count, image::ImageType type);
 | 
			
		||||
 | 
			
		||||
  uint32_t get_animation_frame_count() const;
 | 
			
		||||
  int get_current_frame() const;
 | 
			
		||||
 
 | 
			
		||||
@@ -122,8 +122,7 @@ void APDS9306::update() {
 | 
			
		||||
 | 
			
		||||
  this->status_clear_warning();
 | 
			
		||||
 | 
			
		||||
  status &= 0b00001000;
 | 
			
		||||
  if (!status) {  // No new data
 | 
			
		||||
  if (!(status &= 0b00001000)) {  // No new data
 | 
			
		||||
    return;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -62,8 +62,6 @@ service APIConnection {
 | 
			
		||||
  rpc unsubscribe_bluetooth_le_advertisements(UnsubscribeBluetoothLEAdvertisementsRequest) returns (void) {}
 | 
			
		||||
 | 
			
		||||
  rpc subscribe_voice_assistant(SubscribeVoiceAssistantRequest) returns (void) {}
 | 
			
		||||
  rpc voice_assistant_get_configuration(VoiceAssistantConfigurationRequest) returns (VoiceAssistantConfigurationResponse) {}
 | 
			
		||||
  rpc voice_assistant_set_configuration(VoiceAssistantSetConfiguration) returns (void) {}
 | 
			
		||||
 | 
			
		||||
  rpc alarm_control_panel_command (AlarmControlPanelCommandRequest) returns (void) {}
 | 
			
		||||
}
 | 
			
		||||
@@ -1114,13 +1112,13 @@ enum MediaPlayerFormatPurpose {
 | 
			
		||||
  MEDIA_PLAYER_FORMAT_PURPOSE_ANNOUNCEMENT = 1;
 | 
			
		||||
}
 | 
			
		||||
message MediaPlayerSupportedFormat {
 | 
			
		||||
  option (id) = 119;
 | 
			
		||||
  option (ifdef) = "USE_MEDIA_PLAYER";
 | 
			
		||||
 | 
			
		||||
  string format = 1;
 | 
			
		||||
  uint32 sample_rate = 2;
 | 
			
		||||
  uint32 num_channels = 3;
 | 
			
		||||
  MediaPlayerFormatPurpose purpose = 4;
 | 
			
		||||
  uint32 sample_bytes = 5;
 | 
			
		||||
}
 | 
			
		||||
message ListEntitiesMediaPlayerResponse {
 | 
			
		||||
  option (id) = 63;
 | 
			
		||||
@@ -1381,7 +1379,6 @@ message BluetoothConnectionsFreeResponse {
 | 
			
		||||
 | 
			
		||||
  uint32 free = 1;
 | 
			
		||||
  uint32 limit = 2;
 | 
			
		||||
  repeated uint64 allocated = 3;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
message BluetoothGATTErrorResponse {
 | 
			
		||||
@@ -1557,53 +1554,6 @@ message VoiceAssistantTimerEventResponse {
 | 
			
		||||
  bool is_active = 6;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
message VoiceAssistantAnnounceRequest {
 | 
			
		||||
  option (id) = 119;
 | 
			
		||||
  option (source) = SOURCE_CLIENT;
 | 
			
		||||
  option (ifdef) = "USE_VOICE_ASSISTANT";
 | 
			
		||||
 | 
			
		||||
  string media_id = 1;
 | 
			
		||||
  string text = 2;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
message VoiceAssistantAnnounceFinished {
 | 
			
		||||
  option (id) = 120;
 | 
			
		||||
  option (source) = SOURCE_SERVER;
 | 
			
		||||
  option (ifdef) = "USE_VOICE_ASSISTANT";
 | 
			
		||||
 | 
			
		||||
  bool success = 1;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
message VoiceAssistantWakeWord {
 | 
			
		||||
  string id = 1;
 | 
			
		||||
  string wake_word = 2;
 | 
			
		||||
  repeated string trained_languages = 3;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
message VoiceAssistantConfigurationRequest {
 | 
			
		||||
  option (id) = 121;
 | 
			
		||||
  option (source) = SOURCE_CLIENT;
 | 
			
		||||
  option (ifdef) = "USE_VOICE_ASSISTANT";
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
message VoiceAssistantConfigurationResponse {
 | 
			
		||||
  option (id) = 122;
 | 
			
		||||
  option (source) = SOURCE_SERVER;
 | 
			
		||||
  option (ifdef) = "USE_VOICE_ASSISTANT";
 | 
			
		||||
 | 
			
		||||
  repeated VoiceAssistantWakeWord available_wake_words = 1;
 | 
			
		||||
  repeated string active_wake_words = 2;
 | 
			
		||||
  uint32 max_active_wake_words = 3;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
message VoiceAssistantSetConfiguration {
 | 
			
		||||
  option (id) = 123;
 | 
			
		||||
  option (source) = SOURCE_CLIENT;
 | 
			
		||||
  option (ifdef) = "USE_VOICE_ASSISTANT";
 | 
			
		||||
 | 
			
		||||
  repeated string active_wake_words = 1;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// ==================== ALARM CONTROL PANEL ====================
 | 
			
		||||
enum AlarmControlPanelState {
 | 
			
		||||
  ALARM_STATE_DISARMED = 0;
 | 
			
		||||
 
 | 
			
		||||
@@ -1,5 +1,4 @@
 | 
			
		||||
#include "api_connection.h"
 | 
			
		||||
#ifdef USE_API
 | 
			
		||||
#include <cerrno>
 | 
			
		||||
#include <cinttypes>
 | 
			
		||||
#include <utility>
 | 
			
		||||
@@ -1033,7 +1032,6 @@ bool APIConnection::send_media_player_info(media_player::MediaPlayer *media_play
 | 
			
		||||
    media_format.sample_rate = supported_format.sample_rate;
 | 
			
		||||
    media_format.num_channels = supported_format.num_channels;
 | 
			
		||||
    media_format.purpose = static_cast<enums::MediaPlayerFormatPurpose>(supported_format.purpose);
 | 
			
		||||
    media_format.sample_bytes = supported_format.sample_bytes;
 | 
			
		||||
    msg.supported_formats.push_back(media_format);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
@@ -1215,52 +1213,6 @@ void APIConnection::on_voice_assistant_timer_event_response(const VoiceAssistant
 | 
			
		||||
  }
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
void APIConnection::on_voice_assistant_announce_request(const VoiceAssistantAnnounceRequest &msg) {
 | 
			
		||||
  if (voice_assistant::global_voice_assistant != nullptr) {
 | 
			
		||||
    if (voice_assistant::global_voice_assistant->get_api_connection() != this) {
 | 
			
		||||
      return;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    voice_assistant::global_voice_assistant->on_announce(msg);
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
VoiceAssistantConfigurationResponse APIConnection::voice_assistant_get_configuration(
 | 
			
		||||
    const VoiceAssistantConfigurationRequest &msg) {
 | 
			
		||||
  VoiceAssistantConfigurationResponse resp;
 | 
			
		||||
  if (voice_assistant::global_voice_assistant != nullptr) {
 | 
			
		||||
    if (voice_assistant::global_voice_assistant->get_api_connection() != this) {
 | 
			
		||||
      return resp;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    auto &config = voice_assistant::global_voice_assistant->get_configuration();
 | 
			
		||||
    for (auto &wake_word : config.available_wake_words) {
 | 
			
		||||
      VoiceAssistantWakeWord resp_wake_word;
 | 
			
		||||
      resp_wake_word.id = wake_word.id;
 | 
			
		||||
      resp_wake_word.wake_word = wake_word.wake_word;
 | 
			
		||||
      for (const auto &lang : wake_word.trained_languages) {
 | 
			
		||||
        resp_wake_word.trained_languages.push_back(lang);
 | 
			
		||||
      }
 | 
			
		||||
      resp.available_wake_words.push_back(std::move(resp_wake_word));
 | 
			
		||||
    }
 | 
			
		||||
    for (auto &wake_word_id : config.active_wake_words) {
 | 
			
		||||
      resp.active_wake_words.push_back(wake_word_id);
 | 
			
		||||
    }
 | 
			
		||||
    resp.max_active_wake_words = config.max_active_wake_words;
 | 
			
		||||
  }
 | 
			
		||||
  return resp;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void APIConnection::voice_assistant_set_configuration(const VoiceAssistantSetConfiguration &msg) {
 | 
			
		||||
  if (voice_assistant::global_voice_assistant != nullptr) {
 | 
			
		||||
    if (voice_assistant::global_voice_assistant->get_api_connection() != this) {
 | 
			
		||||
      return;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    voice_assistant::global_voice_assistant->on_set_configuration(msg.active_wake_words);
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_ALARM_CONTROL_PANEL
 | 
			
		||||
@@ -1569,4 +1521,3 @@ void APIConnection::on_fatal_error() {
 | 
			
		||||
 | 
			
		||||
}  // namespace api
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
#endif
 | 
			
		||||
 
 | 
			
		||||
@@ -1,13 +1,12 @@
 | 
			
		||||
#pragma once
 | 
			
		||||
 | 
			
		||||
#include "esphome/core/defines.h"
 | 
			
		||||
#ifdef USE_API
 | 
			
		||||
#include "api_frame_helper.h"
 | 
			
		||||
#include "api_pb2.h"
 | 
			
		||||
#include "api_pb2_service.h"
 | 
			
		||||
#include "api_server.h"
 | 
			
		||||
#include "esphome/core/application.h"
 | 
			
		||||
#include "esphome/core/component.h"
 | 
			
		||||
#include "esphome/core/defines.h"
 | 
			
		||||
 | 
			
		||||
#include <vector>
 | 
			
		||||
 | 
			
		||||
@@ -152,10 +151,6 @@ class APIConnection : public APIServerConnection {
 | 
			
		||||
  void on_voice_assistant_event_response(const VoiceAssistantEventResponse &msg) override;
 | 
			
		||||
  void on_voice_assistant_audio(const VoiceAssistantAudio &msg) override;
 | 
			
		||||
  void on_voice_assistant_timer_event_response(const VoiceAssistantTimerEventResponse &msg) override;
 | 
			
		||||
  void on_voice_assistant_announce_request(const VoiceAssistantAnnounceRequest &msg) override;
 | 
			
		||||
  VoiceAssistantConfigurationResponse voice_assistant_get_configuration(
 | 
			
		||||
      const VoiceAssistantConfigurationRequest &msg) override;
 | 
			
		||||
  void voice_assistant_set_configuration(const VoiceAssistantSetConfiguration &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_ALARM_CONTROL_PANEL
 | 
			
		||||
@@ -269,4 +264,3 @@ class APIConnection : public APIServerConnection {
 | 
			
		||||
 | 
			
		||||
}  // namespace api
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
#endif
 | 
			
		||||
 
 | 
			
		||||
@@ -1,5 +1,5 @@
 | 
			
		||||
#include "api_frame_helper.h"
 | 
			
		||||
#ifdef USE_API
 | 
			
		||||
 | 
			
		||||
#include "esphome/core/log.h"
 | 
			
		||||
#include "esphome/core/hal.h"
 | 
			
		||||
#include "esphome/core/helpers.h"
 | 
			
		||||
@@ -1028,4 +1028,3 @@ APIError APIPlaintextFrameHelper::shutdown(int how) {
 | 
			
		||||
 | 
			
		||||
}  // namespace api
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
#endif
 | 
			
		||||
 
 | 
			
		||||
@@ -5,7 +5,7 @@
 | 
			
		||||
#include <vector>
 | 
			
		||||
 | 
			
		||||
#include "esphome/core/defines.h"
 | 
			
		||||
#ifdef USE_API
 | 
			
		||||
 | 
			
		||||
#ifdef USE_API_NOISE
 | 
			
		||||
#include "noise/protocol.h"
 | 
			
		||||
#endif
 | 
			
		||||
@@ -190,4 +190,3 @@ class APIPlaintextFrameHelper : public APIFrameHelper {
 | 
			
		||||
 | 
			
		||||
}  // namespace api
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
#endif
 | 
			
		||||
 
 | 
			
		||||
@@ -5149,10 +5149,6 @@ bool MediaPlayerSupportedFormat::decode_varint(uint32_t field_id, ProtoVarInt va
 | 
			
		||||
      this->purpose = value.as_enum<enums::MediaPlayerFormatPurpose>();
 | 
			
		||||
      return true;
 | 
			
		||||
    }
 | 
			
		||||
    case 5: {
 | 
			
		||||
      this->sample_bytes = value.as_uint32();
 | 
			
		||||
      return true;
 | 
			
		||||
    }
 | 
			
		||||
    default:
 | 
			
		||||
      return false;
 | 
			
		||||
  }
 | 
			
		||||
@@ -5172,7 +5168,6 @@ void MediaPlayerSupportedFormat::encode(ProtoWriteBuffer buffer) const {
 | 
			
		||||
  buffer.encode_uint32(2, this->sample_rate);
 | 
			
		||||
  buffer.encode_uint32(3, this->num_channels);
 | 
			
		||||
  buffer.encode_enum<enums::MediaPlayerFormatPurpose>(4, this->purpose);
 | 
			
		||||
  buffer.encode_uint32(5, this->sample_bytes);
 | 
			
		||||
}
 | 
			
		||||
#ifdef HAS_PROTO_MESSAGE_DUMP
 | 
			
		||||
void MediaPlayerSupportedFormat::dump_to(std::string &out) const {
 | 
			
		||||
@@ -5195,11 +5190,6 @@ void MediaPlayerSupportedFormat::dump_to(std::string &out) const {
 | 
			
		||||
  out.append("  purpose: ");
 | 
			
		||||
  out.append(proto_enum_to_string<enums::MediaPlayerFormatPurpose>(this->purpose));
 | 
			
		||||
  out.append("\n");
 | 
			
		||||
 | 
			
		||||
  out.append("  sample_bytes: ");
 | 
			
		||||
  sprintf(buffer, "%" PRIu32, this->sample_bytes);
 | 
			
		||||
  out.append(buffer);
 | 
			
		||||
  out.append("\n");
 | 
			
		||||
  out.append("}");
 | 
			
		||||
}
 | 
			
		||||
#endif
 | 
			
		||||
@@ -6430,10 +6420,6 @@ bool BluetoothConnectionsFreeResponse::decode_varint(uint32_t field_id, ProtoVar
 | 
			
		||||
      this->limit = value.as_uint32();
 | 
			
		||||
      return true;
 | 
			
		||||
    }
 | 
			
		||||
    case 3: {
 | 
			
		||||
      this->allocated.push_back(value.as_uint64());
 | 
			
		||||
      return true;
 | 
			
		||||
    }
 | 
			
		||||
    default:
 | 
			
		||||
      return false;
 | 
			
		||||
  }
 | 
			
		||||
@@ -6441,9 +6427,6 @@ bool BluetoothConnectionsFreeResponse::decode_varint(uint32_t field_id, ProtoVar
 | 
			
		||||
void BluetoothConnectionsFreeResponse::encode(ProtoWriteBuffer buffer) const {
 | 
			
		||||
  buffer.encode_uint32(1, this->free);
 | 
			
		||||
  buffer.encode_uint32(2, this->limit);
 | 
			
		||||
  for (auto &it : this->allocated) {
 | 
			
		||||
    buffer.encode_uint64(3, it, true);
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
#ifdef HAS_PROTO_MESSAGE_DUMP
 | 
			
		||||
void BluetoothConnectionsFreeResponse::dump_to(std::string &out) const {
 | 
			
		||||
@@ -6458,13 +6441,6 @@ void BluetoothConnectionsFreeResponse::dump_to(std::string &out) const {
 | 
			
		||||
  sprintf(buffer, "%" PRIu32, this->limit);
 | 
			
		||||
  out.append(buffer);
 | 
			
		||||
  out.append("\n");
 | 
			
		||||
 | 
			
		||||
  for (const auto &it : this->allocated) {
 | 
			
		||||
    out.append("  allocated: ");
 | 
			
		||||
    sprintf(buffer, "%llu", it);
 | 
			
		||||
    out.append(buffer);
 | 
			
		||||
    out.append("\n");
 | 
			
		||||
  }
 | 
			
		||||
  out.append("}");
 | 
			
		||||
}
 | 
			
		||||
#endif
 | 
			
		||||
@@ -7085,193 +7061,6 @@ void VoiceAssistantTimerEventResponse::dump_to(std::string &out) const {
 | 
			
		||||
  out.append("}");
 | 
			
		||||
}
 | 
			
		||||
#endif
 | 
			
		||||
bool VoiceAssistantAnnounceRequest::decode_length(uint32_t field_id, ProtoLengthDelimited value) {
 | 
			
		||||
  switch (field_id) {
 | 
			
		||||
    case 1: {
 | 
			
		||||
      this->media_id = value.as_string();
 | 
			
		||||
      return true;
 | 
			
		||||
    }
 | 
			
		||||
    case 2: {
 | 
			
		||||
      this->text = value.as_string();
 | 
			
		||||
      return true;
 | 
			
		||||
    }
 | 
			
		||||
    default:
 | 
			
		||||
      return false;
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
void VoiceAssistantAnnounceRequest::encode(ProtoWriteBuffer buffer) const {
 | 
			
		||||
  buffer.encode_string(1, this->media_id);
 | 
			
		||||
  buffer.encode_string(2, this->text);
 | 
			
		||||
}
 | 
			
		||||
#ifdef HAS_PROTO_MESSAGE_DUMP
 | 
			
		||||
void VoiceAssistantAnnounceRequest::dump_to(std::string &out) const {
 | 
			
		||||
  __attribute__((unused)) char buffer[64];
 | 
			
		||||
  out.append("VoiceAssistantAnnounceRequest {\n");
 | 
			
		||||
  out.append("  media_id: ");
 | 
			
		||||
  out.append("'").append(this->media_id).append("'");
 | 
			
		||||
  out.append("\n");
 | 
			
		||||
 | 
			
		||||
  out.append("  text: ");
 | 
			
		||||
  out.append("'").append(this->text).append("'");
 | 
			
		||||
  out.append("\n");
 | 
			
		||||
  out.append("}");
 | 
			
		||||
}
 | 
			
		||||
#endif
 | 
			
		||||
bool VoiceAssistantAnnounceFinished::decode_varint(uint32_t field_id, ProtoVarInt value) {
 | 
			
		||||
  switch (field_id) {
 | 
			
		||||
    case 1: {
 | 
			
		||||
      this->success = value.as_bool();
 | 
			
		||||
      return true;
 | 
			
		||||
    }
 | 
			
		||||
    default:
 | 
			
		||||
      return false;
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
void VoiceAssistantAnnounceFinished::encode(ProtoWriteBuffer buffer) const { buffer.encode_bool(1, this->success); }
 | 
			
		||||
#ifdef HAS_PROTO_MESSAGE_DUMP
 | 
			
		||||
void VoiceAssistantAnnounceFinished::dump_to(std::string &out) const {
 | 
			
		||||
  __attribute__((unused)) char buffer[64];
 | 
			
		||||
  out.append("VoiceAssistantAnnounceFinished {\n");
 | 
			
		||||
  out.append("  success: ");
 | 
			
		||||
  out.append(YESNO(this->success));
 | 
			
		||||
  out.append("\n");
 | 
			
		||||
  out.append("}");
 | 
			
		||||
}
 | 
			
		||||
#endif
 | 
			
		||||
bool VoiceAssistantWakeWord::decode_length(uint32_t field_id, ProtoLengthDelimited value) {
 | 
			
		||||
  switch (field_id) {
 | 
			
		||||
    case 1: {
 | 
			
		||||
      this->id = value.as_string();
 | 
			
		||||
      return true;
 | 
			
		||||
    }
 | 
			
		||||
    case 2: {
 | 
			
		||||
      this->wake_word = value.as_string();
 | 
			
		||||
      return true;
 | 
			
		||||
    }
 | 
			
		||||
    case 3: {
 | 
			
		||||
      this->trained_languages.push_back(value.as_string());
 | 
			
		||||
      return true;
 | 
			
		||||
    }
 | 
			
		||||
    default:
 | 
			
		||||
      return false;
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
void VoiceAssistantWakeWord::encode(ProtoWriteBuffer buffer) const {
 | 
			
		||||
  buffer.encode_string(1, this->id);
 | 
			
		||||
  buffer.encode_string(2, this->wake_word);
 | 
			
		||||
  for (auto &it : this->trained_languages) {
 | 
			
		||||
    buffer.encode_string(3, it, true);
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
#ifdef HAS_PROTO_MESSAGE_DUMP
 | 
			
		||||
void VoiceAssistantWakeWord::dump_to(std::string &out) const {
 | 
			
		||||
  __attribute__((unused)) char buffer[64];
 | 
			
		||||
  out.append("VoiceAssistantWakeWord {\n");
 | 
			
		||||
  out.append("  id: ");
 | 
			
		||||
  out.append("'").append(this->id).append("'");
 | 
			
		||||
  out.append("\n");
 | 
			
		||||
 | 
			
		||||
  out.append("  wake_word: ");
 | 
			
		||||
  out.append("'").append(this->wake_word).append("'");
 | 
			
		||||
  out.append("\n");
 | 
			
		||||
 | 
			
		||||
  for (const auto &it : this->trained_languages) {
 | 
			
		||||
    out.append("  trained_languages: ");
 | 
			
		||||
    out.append("'").append(it).append("'");
 | 
			
		||||
    out.append("\n");
 | 
			
		||||
  }
 | 
			
		||||
  out.append("}");
 | 
			
		||||
}
 | 
			
		||||
#endif
 | 
			
		||||
void VoiceAssistantConfigurationRequest::encode(ProtoWriteBuffer buffer) const {}
 | 
			
		||||
#ifdef HAS_PROTO_MESSAGE_DUMP
 | 
			
		||||
void VoiceAssistantConfigurationRequest::dump_to(std::string &out) const {
 | 
			
		||||
  out.append("VoiceAssistantConfigurationRequest {}");
 | 
			
		||||
}
 | 
			
		||||
#endif
 | 
			
		||||
bool VoiceAssistantConfigurationResponse::decode_varint(uint32_t field_id, ProtoVarInt value) {
 | 
			
		||||
  switch (field_id) {
 | 
			
		||||
    case 3: {
 | 
			
		||||
      this->max_active_wake_words = value.as_uint32();
 | 
			
		||||
      return true;
 | 
			
		||||
    }
 | 
			
		||||
    default:
 | 
			
		||||
      return false;
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
bool VoiceAssistantConfigurationResponse::decode_length(uint32_t field_id, ProtoLengthDelimited value) {
 | 
			
		||||
  switch (field_id) {
 | 
			
		||||
    case 1: {
 | 
			
		||||
      this->available_wake_words.push_back(value.as_message<VoiceAssistantWakeWord>());
 | 
			
		||||
      return true;
 | 
			
		||||
    }
 | 
			
		||||
    case 2: {
 | 
			
		||||
      this->active_wake_words.push_back(value.as_string());
 | 
			
		||||
      return true;
 | 
			
		||||
    }
 | 
			
		||||
    default:
 | 
			
		||||
      return false;
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
void VoiceAssistantConfigurationResponse::encode(ProtoWriteBuffer buffer) const {
 | 
			
		||||
  for (auto &it : this->available_wake_words) {
 | 
			
		||||
    buffer.encode_message<VoiceAssistantWakeWord>(1, it, true);
 | 
			
		||||
  }
 | 
			
		||||
  for (auto &it : this->active_wake_words) {
 | 
			
		||||
    buffer.encode_string(2, it, true);
 | 
			
		||||
  }
 | 
			
		||||
  buffer.encode_uint32(3, this->max_active_wake_words);
 | 
			
		||||
}
 | 
			
		||||
#ifdef HAS_PROTO_MESSAGE_DUMP
 | 
			
		||||
void VoiceAssistantConfigurationResponse::dump_to(std::string &out) const {
 | 
			
		||||
  __attribute__((unused)) char buffer[64];
 | 
			
		||||
  out.append("VoiceAssistantConfigurationResponse {\n");
 | 
			
		||||
  for (const auto &it : this->available_wake_words) {
 | 
			
		||||
    out.append("  available_wake_words: ");
 | 
			
		||||
    it.dump_to(out);
 | 
			
		||||
    out.append("\n");
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  for (const auto &it : this->active_wake_words) {
 | 
			
		||||
    out.append("  active_wake_words: ");
 | 
			
		||||
    out.append("'").append(it).append("'");
 | 
			
		||||
    out.append("\n");
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  out.append("  max_active_wake_words: ");
 | 
			
		||||
  sprintf(buffer, "%" PRIu32, this->max_active_wake_words);
 | 
			
		||||
  out.append(buffer);
 | 
			
		||||
  out.append("\n");
 | 
			
		||||
  out.append("}");
 | 
			
		||||
}
 | 
			
		||||
#endif
 | 
			
		||||
bool VoiceAssistantSetConfiguration::decode_length(uint32_t field_id, ProtoLengthDelimited value) {
 | 
			
		||||
  switch (field_id) {
 | 
			
		||||
    case 1: {
 | 
			
		||||
      this->active_wake_words.push_back(value.as_string());
 | 
			
		||||
      return true;
 | 
			
		||||
    }
 | 
			
		||||
    default:
 | 
			
		||||
      return false;
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
void VoiceAssistantSetConfiguration::encode(ProtoWriteBuffer buffer) const {
 | 
			
		||||
  for (auto &it : this->active_wake_words) {
 | 
			
		||||
    buffer.encode_string(1, it, true);
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
#ifdef HAS_PROTO_MESSAGE_DUMP
 | 
			
		||||
void VoiceAssistantSetConfiguration::dump_to(std::string &out) const {
 | 
			
		||||
  __attribute__((unused)) char buffer[64];
 | 
			
		||||
  out.append("VoiceAssistantSetConfiguration {\n");
 | 
			
		||||
  for (const auto &it : this->active_wake_words) {
 | 
			
		||||
    out.append("  active_wake_words: ");
 | 
			
		||||
    out.append("'").append(it).append("'");
 | 
			
		||||
    out.append("\n");
 | 
			
		||||
  }
 | 
			
		||||
  out.append("}");
 | 
			
		||||
}
 | 
			
		||||
#endif
 | 
			
		||||
bool ListEntitiesAlarmControlPanelResponse::decode_varint(uint32_t field_id, ProtoVarInt value) {
 | 
			
		||||
  switch (field_id) {
 | 
			
		||||
    case 6: {
 | 
			
		||||
 
 | 
			
		||||
@@ -1277,7 +1277,6 @@ class MediaPlayerSupportedFormat : public ProtoMessage {
 | 
			
		||||
  uint32_t sample_rate{0};
 | 
			
		||||
  uint32_t num_channels{0};
 | 
			
		||||
  enums::MediaPlayerFormatPurpose purpose{};
 | 
			
		||||
  uint32_t sample_bytes{0};
 | 
			
		||||
  void encode(ProtoWriteBuffer buffer) const override;
 | 
			
		||||
#ifdef HAS_PROTO_MESSAGE_DUMP
 | 
			
		||||
  void dump_to(std::string &out) const override;
 | 
			
		||||
@@ -1624,7 +1623,6 @@ class BluetoothConnectionsFreeResponse : public ProtoMessage {
 | 
			
		||||
 public:
 | 
			
		||||
  uint32_t free{0};
 | 
			
		||||
  uint32_t limit{0};
 | 
			
		||||
  std::vector<uint64_t> allocated{};
 | 
			
		||||
  void encode(ProtoWriteBuffer buffer) const override;
 | 
			
		||||
#ifdef HAS_PROTO_MESSAGE_DUMP
 | 
			
		||||
  void dump_to(std::string &out) const override;
 | 
			
		||||
@@ -1827,76 +1825,6 @@ class VoiceAssistantTimerEventResponse : public ProtoMessage {
 | 
			
		||||
  bool decode_length(uint32_t field_id, ProtoLengthDelimited value) override;
 | 
			
		||||
  bool decode_varint(uint32_t field_id, ProtoVarInt value) override;
 | 
			
		||||
};
 | 
			
		||||
class VoiceAssistantAnnounceRequest : public ProtoMessage {
 | 
			
		||||
 public:
 | 
			
		||||
  std::string media_id{};
 | 
			
		||||
  std::string text{};
 | 
			
		||||
  void encode(ProtoWriteBuffer buffer) const override;
 | 
			
		||||
#ifdef HAS_PROTO_MESSAGE_DUMP
 | 
			
		||||
  void dump_to(std::string &out) const override;
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  bool decode_length(uint32_t field_id, ProtoLengthDelimited value) override;
 | 
			
		||||
};
 | 
			
		||||
class VoiceAssistantAnnounceFinished : public ProtoMessage {
 | 
			
		||||
 public:
 | 
			
		||||
  bool success{false};
 | 
			
		||||
  void encode(ProtoWriteBuffer buffer) const override;
 | 
			
		||||
#ifdef HAS_PROTO_MESSAGE_DUMP
 | 
			
		||||
  void dump_to(std::string &out) const override;
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  bool decode_varint(uint32_t field_id, ProtoVarInt value) override;
 | 
			
		||||
};
 | 
			
		||||
class VoiceAssistantWakeWord : public ProtoMessage {
 | 
			
		||||
 public:
 | 
			
		||||
  std::string id{};
 | 
			
		||||
  std::string wake_word{};
 | 
			
		||||
  std::vector<std::string> trained_languages{};
 | 
			
		||||
  void encode(ProtoWriteBuffer buffer) const override;
 | 
			
		||||
#ifdef HAS_PROTO_MESSAGE_DUMP
 | 
			
		||||
  void dump_to(std::string &out) const override;
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  bool decode_length(uint32_t field_id, ProtoLengthDelimited value) override;
 | 
			
		||||
};
 | 
			
		||||
class VoiceAssistantConfigurationRequest : public ProtoMessage {
 | 
			
		||||
 public:
 | 
			
		||||
  void encode(ProtoWriteBuffer buffer) const override;
 | 
			
		||||
#ifdef HAS_PROTO_MESSAGE_DUMP
 | 
			
		||||
  void dump_to(std::string &out) const override;
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
};
 | 
			
		||||
class VoiceAssistantConfigurationResponse : public ProtoMessage {
 | 
			
		||||
 public:
 | 
			
		||||
  std::vector<VoiceAssistantWakeWord> available_wake_words{};
 | 
			
		||||
  std::vector<std::string> active_wake_words{};
 | 
			
		||||
  uint32_t max_active_wake_words{0};
 | 
			
		||||
  void encode(ProtoWriteBuffer buffer) const override;
 | 
			
		||||
#ifdef HAS_PROTO_MESSAGE_DUMP
 | 
			
		||||
  void dump_to(std::string &out) const override;
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  bool decode_length(uint32_t field_id, ProtoLengthDelimited value) override;
 | 
			
		||||
  bool decode_varint(uint32_t field_id, ProtoVarInt value) override;
 | 
			
		||||
};
 | 
			
		||||
class VoiceAssistantSetConfiguration : public ProtoMessage {
 | 
			
		||||
 public:
 | 
			
		||||
  std::vector<std::string> active_wake_words{};
 | 
			
		||||
  void encode(ProtoWriteBuffer buffer) const override;
 | 
			
		||||
#ifdef HAS_PROTO_MESSAGE_DUMP
 | 
			
		||||
  void dump_to(std::string &out) const override;
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  bool decode_length(uint32_t field_id, ProtoLengthDelimited value) override;
 | 
			
		||||
};
 | 
			
		||||
class ListEntitiesAlarmControlPanelResponse : public ProtoMessage {
 | 
			
		||||
 public:
 | 
			
		||||
  std::string object_id{};
 | 
			
		||||
 
 | 
			
		||||
@@ -311,6 +311,14 @@ bool APIServerConnectionBase::send_list_entities_button_response(const ListEntit
 | 
			
		||||
#ifdef USE_BUTTON
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_MEDIA_PLAYER
 | 
			
		||||
bool APIServerConnectionBase::send_media_player_supported_format(const MediaPlayerSupportedFormat &msg) {
 | 
			
		||||
#ifdef HAS_PROTO_MESSAGE_DUMP
 | 
			
		||||
  ESP_LOGVV(TAG, "send_media_player_supported_format: %s", msg.dump().c_str());
 | 
			
		||||
#endif
 | 
			
		||||
  return this->send_message_<MediaPlayerSupportedFormat>(msg, 119);
 | 
			
		||||
}
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_MEDIA_PLAYER
 | 
			
		||||
bool APIServerConnectionBase::send_list_entities_media_player_response(const ListEntitiesMediaPlayerResponse &msg) {
 | 
			
		||||
#ifdef HAS_PROTO_MESSAGE_DUMP
 | 
			
		||||
  ESP_LOGVV(TAG, "send_list_entities_media_player_response: %s", msg.dump().c_str());
 | 
			
		||||
@@ -486,29 +494,6 @@ bool APIServerConnectionBase::send_voice_assistant_audio(const VoiceAssistantAud
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_VOICE_ASSISTANT
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_VOICE_ASSISTANT
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_VOICE_ASSISTANT
 | 
			
		||||
bool APIServerConnectionBase::send_voice_assistant_announce_finished(const VoiceAssistantAnnounceFinished &msg) {
 | 
			
		||||
#ifdef HAS_PROTO_MESSAGE_DUMP
 | 
			
		||||
  ESP_LOGVV(TAG, "send_voice_assistant_announce_finished: %s", msg.dump().c_str());
 | 
			
		||||
#endif
 | 
			
		||||
  return this->send_message_<VoiceAssistantAnnounceFinished>(msg, 120);
 | 
			
		||||
}
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_VOICE_ASSISTANT
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_VOICE_ASSISTANT
 | 
			
		||||
bool APIServerConnectionBase::send_voice_assistant_configuration_response(
 | 
			
		||||
    const VoiceAssistantConfigurationResponse &msg) {
 | 
			
		||||
#ifdef HAS_PROTO_MESSAGE_DUMP
 | 
			
		||||
  ESP_LOGVV(TAG, "send_voice_assistant_configuration_response: %s", msg.dump().c_str());
 | 
			
		||||
#endif
 | 
			
		||||
  return this->send_message_<VoiceAssistantConfigurationResponse>(msg, 122);
 | 
			
		||||
}
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_VOICE_ASSISTANT
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_ALARM_CONTROL_PANEL
 | 
			
		||||
bool APIServerConnectionBase::send_list_entities_alarm_control_panel_response(
 | 
			
		||||
    const ListEntitiesAlarmControlPanelResponse &msg) {
 | 
			
		||||
@@ -1162,35 +1147,13 @@ bool APIServerConnectionBase::read_message(uint32_t msg_size, uint32_t msg_type,
 | 
			
		||||
      break;
 | 
			
		||||
    }
 | 
			
		||||
    case 119: {
 | 
			
		||||
#ifdef USE_VOICE_ASSISTANT
 | 
			
		||||
      VoiceAssistantAnnounceRequest msg;
 | 
			
		||||
#ifdef USE_MEDIA_PLAYER
 | 
			
		||||
      MediaPlayerSupportedFormat msg;
 | 
			
		||||
      msg.decode(msg_data, msg_size);
 | 
			
		||||
#ifdef HAS_PROTO_MESSAGE_DUMP
 | 
			
		||||
      ESP_LOGVV(TAG, "on_voice_assistant_announce_request: %s", msg.dump().c_str());
 | 
			
		||||
      ESP_LOGVV(TAG, "on_media_player_supported_format: %s", msg.dump().c_str());
 | 
			
		||||
#endif
 | 
			
		||||
      this->on_voice_assistant_announce_request(msg);
 | 
			
		||||
#endif
 | 
			
		||||
      break;
 | 
			
		||||
    }
 | 
			
		||||
    case 121: {
 | 
			
		||||
#ifdef USE_VOICE_ASSISTANT
 | 
			
		||||
      VoiceAssistantConfigurationRequest msg;
 | 
			
		||||
      msg.decode(msg_data, msg_size);
 | 
			
		||||
#ifdef HAS_PROTO_MESSAGE_DUMP
 | 
			
		||||
      ESP_LOGVV(TAG, "on_voice_assistant_configuration_request: %s", msg.dump().c_str());
 | 
			
		||||
#endif
 | 
			
		||||
      this->on_voice_assistant_configuration_request(msg);
 | 
			
		||||
#endif
 | 
			
		||||
      break;
 | 
			
		||||
    }
 | 
			
		||||
    case 123: {
 | 
			
		||||
#ifdef USE_VOICE_ASSISTANT
 | 
			
		||||
      VoiceAssistantSetConfiguration msg;
 | 
			
		||||
      msg.decode(msg_data, msg_size);
 | 
			
		||||
#ifdef HAS_PROTO_MESSAGE_DUMP
 | 
			
		||||
      ESP_LOGVV(TAG, "on_voice_assistant_set_configuration: %s", msg.dump().c_str());
 | 
			
		||||
#endif
 | 
			
		||||
      this->on_voice_assistant_set_configuration(msg);
 | 
			
		||||
      this->on_media_player_supported_format(msg);
 | 
			
		||||
#endif
 | 
			
		||||
      break;
 | 
			
		||||
    }
 | 
			
		||||
@@ -1681,35 +1644,6 @@ void APIServerConnection::on_subscribe_voice_assistant_request(const SubscribeVo
 | 
			
		||||
  this->subscribe_voice_assistant(msg);
 | 
			
		||||
}
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_VOICE_ASSISTANT
 | 
			
		||||
void APIServerConnection::on_voice_assistant_configuration_request(const VoiceAssistantConfigurationRequest &msg) {
 | 
			
		||||
  if (!this->is_connection_setup()) {
 | 
			
		||||
    this->on_no_setup_connection();
 | 
			
		||||
    return;
 | 
			
		||||
  }
 | 
			
		||||
  if (!this->is_authenticated()) {
 | 
			
		||||
    this->on_unauthenticated_access();
 | 
			
		||||
    return;
 | 
			
		||||
  }
 | 
			
		||||
  VoiceAssistantConfigurationResponse ret = this->voice_assistant_get_configuration(msg);
 | 
			
		||||
  if (!this->send_voice_assistant_configuration_response(ret)) {
 | 
			
		||||
    this->on_fatal_error();
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_VOICE_ASSISTANT
 | 
			
		||||
void APIServerConnection::on_voice_assistant_set_configuration(const VoiceAssistantSetConfiguration &msg) {
 | 
			
		||||
  if (!this->is_connection_setup()) {
 | 
			
		||||
    this->on_no_setup_connection();
 | 
			
		||||
    return;
 | 
			
		||||
  }
 | 
			
		||||
  if (!this->is_authenticated()) {
 | 
			
		||||
    this->on_unauthenticated_access();
 | 
			
		||||
    return;
 | 
			
		||||
  }
 | 
			
		||||
  this->voice_assistant_set_configuration(msg);
 | 
			
		||||
}
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_ALARM_CONTROL_PANEL
 | 
			
		||||
void APIServerConnection::on_alarm_control_panel_command_request(const AlarmControlPanelCommandRequest &msg) {
 | 
			
		||||
  if (!this->is_connection_setup()) {
 | 
			
		||||
 
 | 
			
		||||
@@ -145,6 +145,10 @@ class APIServerConnectionBase : public ProtoService {
 | 
			
		||||
#ifdef USE_BUTTON
 | 
			
		||||
  virtual void on_button_command_request(const ButtonCommandRequest &value){};
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_MEDIA_PLAYER
 | 
			
		||||
  bool send_media_player_supported_format(const MediaPlayerSupportedFormat &msg);
 | 
			
		||||
  virtual void on_media_player_supported_format(const MediaPlayerSupportedFormat &value){};
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_MEDIA_PLAYER
 | 
			
		||||
  bool send_list_entities_media_player_response(const ListEntitiesMediaPlayerResponse &msg);
 | 
			
		||||
#endif
 | 
			
		||||
@@ -247,21 +251,6 @@ class APIServerConnectionBase : public ProtoService {
 | 
			
		||||
#ifdef USE_VOICE_ASSISTANT
 | 
			
		||||
  virtual void on_voice_assistant_timer_event_response(const VoiceAssistantTimerEventResponse &value){};
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_VOICE_ASSISTANT
 | 
			
		||||
  virtual void on_voice_assistant_announce_request(const VoiceAssistantAnnounceRequest &value){};
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_VOICE_ASSISTANT
 | 
			
		||||
  bool send_voice_assistant_announce_finished(const VoiceAssistantAnnounceFinished &msg);
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_VOICE_ASSISTANT
 | 
			
		||||
  virtual void on_voice_assistant_configuration_request(const VoiceAssistantConfigurationRequest &value){};
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_VOICE_ASSISTANT
 | 
			
		||||
  bool send_voice_assistant_configuration_response(const VoiceAssistantConfigurationResponse &msg);
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_VOICE_ASSISTANT
 | 
			
		||||
  virtual void on_voice_assistant_set_configuration(const VoiceAssistantSetConfiguration &value){};
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_ALARM_CONTROL_PANEL
 | 
			
		||||
  bool send_list_entities_alarm_control_panel_response(const ListEntitiesAlarmControlPanelResponse &msg);
 | 
			
		||||
#endif
 | 
			
		||||
@@ -434,13 +423,6 @@ class APIServerConnection : public APIServerConnectionBase {
 | 
			
		||||
#ifdef USE_VOICE_ASSISTANT
 | 
			
		||||
  virtual void subscribe_voice_assistant(const SubscribeVoiceAssistantRequest &msg) = 0;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_VOICE_ASSISTANT
 | 
			
		||||
  virtual VoiceAssistantConfigurationResponse voice_assistant_get_configuration(
 | 
			
		||||
      const VoiceAssistantConfigurationRequest &msg) = 0;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_VOICE_ASSISTANT
 | 
			
		||||
  virtual void voice_assistant_set_configuration(const VoiceAssistantSetConfiguration &msg) = 0;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_ALARM_CONTROL_PANEL
 | 
			
		||||
  virtual void alarm_control_panel_command(const AlarmControlPanelCommandRequest &msg) = 0;
 | 
			
		||||
#endif
 | 
			
		||||
@@ -542,12 +524,6 @@ class APIServerConnection : public APIServerConnectionBase {
 | 
			
		||||
#ifdef USE_VOICE_ASSISTANT
 | 
			
		||||
  void on_subscribe_voice_assistant_request(const SubscribeVoiceAssistantRequest &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_VOICE_ASSISTANT
 | 
			
		||||
  void on_voice_assistant_configuration_request(const VoiceAssistantConfigurationRequest &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_VOICE_ASSISTANT
 | 
			
		||||
  void on_voice_assistant_set_configuration(const VoiceAssistantSetConfiguration &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_ALARM_CONTROL_PANEL
 | 
			
		||||
  void on_alarm_control_panel_command_request(const AlarmControlPanelCommandRequest &msg) override;
 | 
			
		||||
#endif
 | 
			
		||||
 
 | 
			
		||||
@@ -1,5 +1,4 @@
 | 
			
		||||
#include "api_server.h"
 | 
			
		||||
#ifdef USE_API
 | 
			
		||||
#include <cerrno>
 | 
			
		||||
#include "api_connection.h"
 | 
			
		||||
#include "esphome/components/network/util.h"
 | 
			
		||||
@@ -404,4 +403,3 @@ void APIServer::on_alarm_control_panel_update(alarm_control_panel::AlarmControlP
 | 
			
		||||
 | 
			
		||||
}  // namespace api
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
#endif
 | 
			
		||||
 
 | 
			
		||||
@@ -1,7 +1,5 @@
 | 
			
		||||
#pragma once
 | 
			
		||||
 | 
			
		||||
#include "esphome/core/defines.h"
 | 
			
		||||
#ifdef USE_API
 | 
			
		||||
#include "api_noise_context.h"
 | 
			
		||||
#include "api_pb2.h"
 | 
			
		||||
#include "api_pb2_service.h"
 | 
			
		||||
@@ -9,6 +7,7 @@
 | 
			
		||||
#include "esphome/core/automation.h"
 | 
			
		||||
#include "esphome/core/component.h"
 | 
			
		||||
#include "esphome/core/controller.h"
 | 
			
		||||
#include "esphome/core/defines.h"
 | 
			
		||||
#include "esphome/core/log.h"
 | 
			
		||||
#include "list_entities.h"
 | 
			
		||||
#include "subscribe_state.h"
 | 
			
		||||
@@ -154,4 +153,3 @@ template<typename... Ts> class APIConnectedCondition : public Condition<Ts...> {
 | 
			
		||||
 | 
			
		||||
}  // namespace api
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
#endif
 | 
			
		||||
 
 | 
			
		||||
@@ -1,11 +1,12 @@
 | 
			
		||||
from __future__ import annotations
 | 
			
		||||
 | 
			
		||||
import asyncio
 | 
			
		||||
from datetime import datetime
 | 
			
		||||
import logging
 | 
			
		||||
from typing import TYPE_CHECKING, Any
 | 
			
		||||
from datetime import datetime
 | 
			
		||||
from typing import Any
 | 
			
		||||
 | 
			
		||||
from aioesphomeapi import APIClient
 | 
			
		||||
from aioesphomeapi.api_pb2 import SubscribeLogsResponse
 | 
			
		||||
from aioesphomeapi.log_runner import async_run
 | 
			
		||||
 | 
			
		||||
from esphome.const import CONF_KEY, CONF_PASSWORD, CONF_PORT, __version__
 | 
			
		||||
@@ -13,12 +14,6 @@ from esphome.core import CORE
 | 
			
		||||
 | 
			
		||||
from . import CONF_ENCRYPTION
 | 
			
		||||
 | 
			
		||||
if TYPE_CHECKING:
 | 
			
		||||
    from aioesphomeapi.api_pb2 import (
 | 
			
		||||
        SubscribeLogsResponse,  # pylint: disable=no-name-in-module
 | 
			
		||||
    )
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
_LOGGER = logging.getLogger(__name__)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -1,9 +1,9 @@
 | 
			
		||||
#pragma once
 | 
			
		||||
 | 
			
		||||
#include <map>
 | 
			
		||||
#include "api_server.h"
 | 
			
		||||
#ifdef USE_API
 | 
			
		||||
#include "user_services.h"
 | 
			
		||||
#include "api_server.h"
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace api {
 | 
			
		||||
 | 
			
		||||
@@ -216,4 +216,3 @@ class CustomAPIDevice {
 | 
			
		||||
 | 
			
		||||
}  // namespace api
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
#endif
 | 
			
		||||
 
 | 
			
		||||
@@ -1,10 +1,10 @@
 | 
			
		||||
#pragma once
 | 
			
		||||
 | 
			
		||||
#include "api_server.h"
 | 
			
		||||
#ifdef USE_API
 | 
			
		||||
#include "api_pb2.h"
 | 
			
		||||
#include "esphome/core/helpers.h"
 | 
			
		||||
#include "esphome/core/automation.h"
 | 
			
		||||
#include "api_pb2.h"
 | 
			
		||||
#include "api_server.h"
 | 
			
		||||
 | 
			
		||||
#include <vector>
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
@@ -81,4 +81,3 @@ template<typename... Ts> class HomeAssistantServiceCallAction : public Action<Ts
 | 
			
		||||
 | 
			
		||||
}  // namespace api
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
#endif
 | 
			
		||||
 
 | 
			
		||||
@@ -1,5 +1,4 @@
 | 
			
		||||
#include "list_entities.h"
 | 
			
		||||
#ifdef USE_API
 | 
			
		||||
#include "api_connection.h"
 | 
			
		||||
#include "esphome/core/application.h"
 | 
			
		||||
#include "esphome/core/log.h"
 | 
			
		||||
@@ -105,4 +104,3 @@ bool ListEntitiesIterator::on_update(update::UpdateEntity *update) { return this
 | 
			
		||||
 | 
			
		||||
}  // namespace api
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
#endif
 | 
			
		||||
 
 | 
			
		||||
@@ -1,9 +1,9 @@
 | 
			
		||||
#pragma once
 | 
			
		||||
 | 
			
		||||
#include "esphome/core/defines.h"
 | 
			
		||||
#ifdef USE_API
 | 
			
		||||
#include "esphome/core/component.h"
 | 
			
		||||
#include "esphome/core/component_iterator.h"
 | 
			
		||||
#include "esphome/core/defines.h"
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace api {
 | 
			
		||||
 | 
			
		||||
@@ -87,4 +87,3 @@ class ListEntitiesIterator : public ComponentIterator {
 | 
			
		||||
 | 
			
		||||
}  // namespace api
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
#endif
 | 
			
		||||
 
 | 
			
		||||
@@ -1,5 +1,4 @@
 | 
			
		||||
#include "subscribe_state.h"
 | 
			
		||||
#ifdef USE_API
 | 
			
		||||
#include "api_connection.h"
 | 
			
		||||
#include "esphome/core/log.h"
 | 
			
		||||
 | 
			
		||||
@@ -85,4 +84,3 @@ InitialStateIterator::InitialStateIterator(APIConnection *client) : client_(clie
 | 
			
		||||
 | 
			
		||||
}  // namespace api
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
#endif
 | 
			
		||||
 
 | 
			
		||||
@@ -1,10 +1,10 @@
 | 
			
		||||
#pragma once
 | 
			
		||||
 | 
			
		||||
#include "esphome/core/defines.h"
 | 
			
		||||
#ifdef USE_API
 | 
			
		||||
#include "esphome/core/component.h"
 | 
			
		||||
#include "esphome/core/component_iterator.h"
 | 
			
		||||
#include "esphome/core/controller.h"
 | 
			
		||||
#include "esphome/core/defines.h"
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace api {
 | 
			
		||||
 | 
			
		||||
@@ -82,4 +82,3 @@ class InitialStateIterator : public ComponentIterator {
 | 
			
		||||
 | 
			
		||||
}  // namespace api
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
#endif
 | 
			
		||||
 
 | 
			
		||||
@@ -1,13 +1,13 @@
 | 
			
		||||
# Dummy integration to allow relying on AsyncTCP
 | 
			
		||||
import esphome.codegen as cg
 | 
			
		||||
import esphome.config_validation as cv
 | 
			
		||||
from esphome.core import CORE, coroutine_with_priority
 | 
			
		||||
from esphome.const import (
 | 
			
		||||
    PLATFORM_BK72XX,
 | 
			
		||||
    PLATFORM_ESP32,
 | 
			
		||||
    PLATFORM_ESP8266,
 | 
			
		||||
    PLATFORM_BK72XX,
 | 
			
		||||
    PLATFORM_RTL87XX,
 | 
			
		||||
)
 | 
			
		||||
from esphome.core import CORE, coroutine_with_priority
 | 
			
		||||
 | 
			
		||||
CODEOWNERS = ["@OttoWinter"]
 | 
			
		||||
 | 
			
		||||
@@ -22,7 +22,7 @@ CONFIG_SCHEMA = cv.All(
 | 
			
		||||
async def to_code(config):
 | 
			
		||||
    if CORE.is_esp32 or CORE.is_libretiny:
 | 
			
		||||
        # https://github.com/esphome/AsyncTCP/blob/master/library.json
 | 
			
		||||
        cg.add_library("esphome/AsyncTCP-esphome", "2.1.4")
 | 
			
		||||
        cg.add_library("esphome/AsyncTCP-esphome", "2.1.3")
 | 
			
		||||
    elif CORE.is_esp8266:
 | 
			
		||||
        # https://github.com/esphome/ESPAsyncTCP
 | 
			
		||||
        cg.add_library("esphome/ESPAsyncTCP-esphome", "2.0.0")
 | 
			
		||||
 
 | 
			
		||||
@@ -1,121 +0,0 @@
 | 
			
		||||
import esphome.codegen as cg
 | 
			
		||||
import esphome.config_validation as cv
 | 
			
		||||
from esphome.const import CONF_BITS_PER_SAMPLE, CONF_NUM_CHANNELS, CONF_SAMPLE_RATE
 | 
			
		||||
import esphome.final_validate as fv
 | 
			
		||||
 | 
			
		||||
CODEOWNERS = ["@kahrendt"]
 | 
			
		||||
audio_ns = cg.esphome_ns.namespace("audio")
 | 
			
		||||
 | 
			
		||||
AudioFile = audio_ns.struct("AudioFile")
 | 
			
		||||
AudioFileType = audio_ns.enum("AudioFileType", is_class=True)
 | 
			
		||||
AUDIO_FILE_TYPE_ENUM = {
 | 
			
		||||
    "NONE": AudioFileType.NONE,
 | 
			
		||||
    "WAV": AudioFileType.WAV,
 | 
			
		||||
    "MP3": AudioFileType.MP3,
 | 
			
		||||
    "FLAC": AudioFileType.FLAC,
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
CONF_MIN_BITS_PER_SAMPLE = "min_bits_per_sample"
 | 
			
		||||
CONF_MAX_BITS_PER_SAMPLE = "max_bits_per_sample"
 | 
			
		||||
CONF_MIN_CHANNELS = "min_channels"
 | 
			
		||||
CONF_MAX_CHANNELS = "max_channels"
 | 
			
		||||
CONF_MIN_SAMPLE_RATE = "min_sample_rate"
 | 
			
		||||
CONF_MAX_SAMPLE_RATE = "max_sample_rate"
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
CONFIG_SCHEMA = cv.All(
 | 
			
		||||
    cv.Schema({}),
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
AUDIO_COMPONENT_SCHEMA = cv.Schema(
 | 
			
		||||
    {
 | 
			
		||||
        cv.Optional(CONF_BITS_PER_SAMPLE): cv.int_range(8, 32),
 | 
			
		||||
        cv.Optional(CONF_NUM_CHANNELS): cv.int_range(1, 2),
 | 
			
		||||
        cv.Optional(CONF_SAMPLE_RATE): cv.int_range(8000, 48000),
 | 
			
		||||
    }
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
_UNDEF = object()
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
def set_stream_limits(
 | 
			
		||||
    min_bits_per_sample: int = _UNDEF,
 | 
			
		||||
    max_bits_per_sample: int = _UNDEF,
 | 
			
		||||
    min_channels: int = _UNDEF,
 | 
			
		||||
    max_channels: int = _UNDEF,
 | 
			
		||||
    min_sample_rate: int = _UNDEF,
 | 
			
		||||
    max_sample_rate: int = _UNDEF,
 | 
			
		||||
):
 | 
			
		||||
    def set_limits_in_config(config):
 | 
			
		||||
        if min_bits_per_sample is not _UNDEF:
 | 
			
		||||
            config[CONF_MIN_BITS_PER_SAMPLE] = min_bits_per_sample
 | 
			
		||||
        if max_bits_per_sample is not _UNDEF:
 | 
			
		||||
            config[CONF_MAX_BITS_PER_SAMPLE] = max_bits_per_sample
 | 
			
		||||
        if min_channels is not _UNDEF:
 | 
			
		||||
            config[CONF_MIN_CHANNELS] = min_channels
 | 
			
		||||
        if max_channels is not _UNDEF:
 | 
			
		||||
            config[CONF_MAX_CHANNELS] = max_channels
 | 
			
		||||
        if min_sample_rate is not _UNDEF:
 | 
			
		||||
            config[CONF_MIN_SAMPLE_RATE] = min_sample_rate
 | 
			
		||||
        if max_sample_rate is not _UNDEF:
 | 
			
		||||
            config[CONF_MAX_SAMPLE_RATE] = max_sample_rate
 | 
			
		||||
 | 
			
		||||
    return set_limits_in_config
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
def final_validate_audio_schema(
 | 
			
		||||
    name: str,
 | 
			
		||||
    *,
 | 
			
		||||
    audio_device: str,
 | 
			
		||||
    bits_per_sample: int,
 | 
			
		||||
    channels: int,
 | 
			
		||||
    sample_rate: int,
 | 
			
		||||
):
 | 
			
		||||
    def validate_audio_compatiblity(audio_config):
 | 
			
		||||
        audio_schema = {}
 | 
			
		||||
 | 
			
		||||
        try:
 | 
			
		||||
            cv.int_range(
 | 
			
		||||
                min=audio_config.get(CONF_MIN_BITS_PER_SAMPLE),
 | 
			
		||||
                max=audio_config.get(CONF_MAX_BITS_PER_SAMPLE),
 | 
			
		||||
            )(bits_per_sample)
 | 
			
		||||
        except cv.Invalid as exc:
 | 
			
		||||
            raise cv.Invalid(
 | 
			
		||||
                f"Invalid configuration for the {name} component. The {CONF_BITS_PER_SAMPLE} {str(exc)}"
 | 
			
		||||
            ) from exc
 | 
			
		||||
 | 
			
		||||
        try:
 | 
			
		||||
            cv.int_range(
 | 
			
		||||
                min=audio_config.get(CONF_MIN_CHANNELS),
 | 
			
		||||
                max=audio_config.get(CONF_MAX_CHANNELS),
 | 
			
		||||
            )(channels)
 | 
			
		||||
        except cv.Invalid as exc:
 | 
			
		||||
            raise cv.Invalid(
 | 
			
		||||
                f"Invalid configuration for the {name} component. The {CONF_NUM_CHANNELS} {str(exc)}"
 | 
			
		||||
            ) from exc
 | 
			
		||||
 | 
			
		||||
        try:
 | 
			
		||||
            cv.int_range(
 | 
			
		||||
                min=audio_config.get(CONF_MIN_SAMPLE_RATE),
 | 
			
		||||
                max=audio_config.get(CONF_MAX_SAMPLE_RATE),
 | 
			
		||||
            )(sample_rate)
 | 
			
		||||
            return cv.Schema(audio_schema, extra=cv.ALLOW_EXTRA)(audio_config)
 | 
			
		||||
        except cv.Invalid as exc:
 | 
			
		||||
            raise cv.Invalid(
 | 
			
		||||
                f"Invalid configuration for the {name} component. The {CONF_SAMPLE_RATE} {str(exc)}"
 | 
			
		||||
            ) from exc
 | 
			
		||||
 | 
			
		||||
    return cv.Schema(
 | 
			
		||||
        {
 | 
			
		||||
            cv.Required(audio_device): fv.id_declaration_match_schema(
 | 
			
		||||
                validate_audio_compatiblity
 | 
			
		||||
            )
 | 
			
		||||
        },
 | 
			
		||||
        extra=cv.ALLOW_EXTRA,
 | 
			
		||||
    )
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
async def to_code(config):
 | 
			
		||||
    cg.add_library("esphome/esp-audio-libs", "1.1.1")
 | 
			
		||||
@@ -1,67 +0,0 @@
 | 
			
		||||
#include "audio.h"
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace audio {
 | 
			
		||||
 | 
			
		||||
// Euclidean's algorithm for finding the greatest common divisor
 | 
			
		||||
static uint32_t gcd(uint32_t a, uint32_t b) {
 | 
			
		||||
  while (b != 0) {
 | 
			
		||||
    uint32_t t = b;
 | 
			
		||||
    b = a % b;
 | 
			
		||||
    a = t;
 | 
			
		||||
  }
 | 
			
		||||
  return a;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
AudioStreamInfo::AudioStreamInfo(uint8_t bits_per_sample, uint8_t channels, uint32_t sample_rate)
 | 
			
		||||
    : bits_per_sample_(bits_per_sample), channels_(channels), sample_rate_(sample_rate) {
 | 
			
		||||
  this->ms_sample_rate_gcd_ = gcd(1000, this->sample_rate_);
 | 
			
		||||
  this->bytes_per_sample_ = (this->bits_per_sample_ + 7) / 8;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
uint32_t AudioStreamInfo::frames_to_microseconds(uint32_t frames) const {
 | 
			
		||||
  return (frames * 1000000 + (this->sample_rate_ >> 1)) / this->sample_rate_;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
uint32_t AudioStreamInfo::frames_to_milliseconds_with_remainder(uint32_t *total_frames) const {
 | 
			
		||||
  uint32_t unprocessable_frames = *total_frames % (this->sample_rate_ / this->ms_sample_rate_gcd_);
 | 
			
		||||
  uint32_t frames_for_ms_calculation = *total_frames - unprocessable_frames;
 | 
			
		||||
 | 
			
		||||
  uint32_t playback_ms = (frames_for_ms_calculation * 1000) / this->sample_rate_;
 | 
			
		||||
  *total_frames = unprocessable_frames;
 | 
			
		||||
  return playback_ms;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
bool AudioStreamInfo::operator==(const AudioStreamInfo &rhs) const {
 | 
			
		||||
  return (this->bits_per_sample_ == rhs.get_bits_per_sample()) && (this->channels_ == rhs.get_channels()) &&
 | 
			
		||||
         (this->sample_rate_ == rhs.get_sample_rate());
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
const char *audio_file_type_to_string(AudioFileType file_type) {
 | 
			
		||||
  switch (file_type) {
 | 
			
		||||
#ifdef USE_AUDIO_FLAC_SUPPORT
 | 
			
		||||
    case AudioFileType::FLAC:
 | 
			
		||||
      return "FLAC";
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_AUDIO_MP3_SUPPORT
 | 
			
		||||
    case AudioFileType::MP3:
 | 
			
		||||
      return "MP3";
 | 
			
		||||
#endif
 | 
			
		||||
    case AudioFileType::WAV:
 | 
			
		||||
      return "WAV";
 | 
			
		||||
    default:
 | 
			
		||||
      return "unknown";
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void scale_audio_samples(const int16_t *audio_samples, int16_t *output_buffer, int16_t scale_factor,
 | 
			
		||||
                         size_t samples_to_scale) {
 | 
			
		||||
  // Note the assembly dsps_mulc function has audio glitches if the input and output buffers are the same.
 | 
			
		||||
  for (int i = 0; i < samples_to_scale; i++) {
 | 
			
		||||
    int32_t acc = (int32_t) audio_samples[i] * (int32_t) scale_factor;
 | 
			
		||||
    output_buffer[i] = (int16_t) (acc >> 15);
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
}  // namespace audio
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
@@ -1,139 +0,0 @@
 | 
			
		||||
#pragma once
 | 
			
		||||
 | 
			
		||||
#include "esphome/core/defines.h"
 | 
			
		||||
 | 
			
		||||
#include <cstddef>
 | 
			
		||||
#include <cstdint>
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace audio {
 | 
			
		||||
 | 
			
		||||
class AudioStreamInfo {
 | 
			
		||||
  /* Class to respresent important parameters of the audio stream that also provides helper function to convert between
 | 
			
		||||
   * various audio related units.
 | 
			
		||||
   *
 | 
			
		||||
   *  - An audio sample represents a unit of audio for one channel.
 | 
			
		||||
   *  - A frame represents a unit of audio with a sample for every channel.
 | 
			
		||||
   *
 | 
			
		||||
   * In gneneral, converting between bytes, samples, and frames shouldn't result in rounding errors so long as frames
 | 
			
		||||
   * are used as the main unit when transferring audio data. Durations may result in rounding for certain sample rates;
 | 
			
		||||
   * e.g., 44.1 KHz. The ``frames_to_milliseconds_with_remainder`` function should be used for accuracy, as it takes
 | 
			
		||||
   * into account the remainder rather than just ignoring any rounding.
 | 
			
		||||
   */
 | 
			
		||||
 public:
 | 
			
		||||
  AudioStreamInfo()
 | 
			
		||||
      : AudioStreamInfo(16, 1, 16000){};  // Default values represent ESPHome's audio components historical values
 | 
			
		||||
  AudioStreamInfo(uint8_t bits_per_sample, uint8_t channels, uint32_t sample_rate);
 | 
			
		||||
 | 
			
		||||
  uint8_t get_bits_per_sample() const { return this->bits_per_sample_; }
 | 
			
		||||
  uint8_t get_channels() const { return this->channels_; }
 | 
			
		||||
  uint32_t get_sample_rate() const { return this->sample_rate_; }
 | 
			
		||||
 | 
			
		||||
  /// @brief Convert bytes to duration in milliseconds.
 | 
			
		||||
  /// @param bytes Number of bytes to convert
 | 
			
		||||
  /// @return Duration in milliseconds that will store `bytes` bytes of audio. May round down for certain sample rates
 | 
			
		||||
  ///         or values of `bytes`.
 | 
			
		||||
  uint32_t bytes_to_ms(size_t bytes) const {
 | 
			
		||||
    return bytes * 1000 / (this->sample_rate_ * this->bytes_per_sample_ * this->channels_);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /// @brief Convert bytes to frames.
 | 
			
		||||
  /// @param bytes Number of bytes to convert
 | 
			
		||||
  /// @return Audio frames that will store `bytes` bytes.
 | 
			
		||||
  uint32_t bytes_to_frames(size_t bytes) const { return (bytes / (this->bytes_per_sample_ * this->channels_)); }
 | 
			
		||||
 | 
			
		||||
  /// @brief Convert bytes to samples.
 | 
			
		||||
  /// @param bytes Number of bytes to convert
 | 
			
		||||
  /// @return Audio samples that will store `bytes` bytes.
 | 
			
		||||
  uint32_t bytes_to_samples(size_t bytes) const { return (bytes / this->bytes_per_sample_); }
 | 
			
		||||
 | 
			
		||||
  /// @brief Converts frames to bytes.
 | 
			
		||||
  /// @param frames Number of frames to convert.
 | 
			
		||||
  /// @return Number of bytes that will store `frames` frames of audio.
 | 
			
		||||
  size_t frames_to_bytes(uint32_t frames) const { return frames * this->bytes_per_sample_ * this->channels_; }
 | 
			
		||||
 | 
			
		||||
  /// @brief Converts samples to bytes.
 | 
			
		||||
  /// @param samples Number of samples to convert.
 | 
			
		||||
  /// @return Number of bytes that will store `samples` samples of audio.
 | 
			
		||||
  size_t samples_to_bytes(uint32_t samples) const { return samples * this->bytes_per_sample_; }
 | 
			
		||||
 | 
			
		||||
  /// @brief Converts duration to frames.
 | 
			
		||||
  /// @param ms Duration in milliseconds
 | 
			
		||||
  /// @return Audio frames that will store `ms` milliseconds of audio.  May round down for certain sample rates.
 | 
			
		||||
  uint32_t ms_to_frames(uint32_t ms) const { return (ms * this->sample_rate_) / 1000; }
 | 
			
		||||
 | 
			
		||||
  /// @brief Converts duration to samples.
 | 
			
		||||
  /// @param ms Duration in milliseconds
 | 
			
		||||
  /// @return Audio samples that will store `ms` milliseconds of audio.  May round down for certain sample rates.
 | 
			
		||||
  uint32_t ms_to_samples(uint32_t ms) const { return (ms * this->channels_ * this->sample_rate_) / 1000; }
 | 
			
		||||
 | 
			
		||||
  /// @brief Converts duration to bytes. May round down for certain sample rates.
 | 
			
		||||
  /// @param ms Duration in milliseconds
 | 
			
		||||
  /// @return Bytes that will store `ms` milliseconds of audio.  May round down for certain sample rates.
 | 
			
		||||
  size_t ms_to_bytes(uint32_t ms) const {
 | 
			
		||||
    return (ms * this->bytes_per_sample_ * this->channels_ * this->sample_rate_) / 1000;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  /// @brief Computes the duration, in microseconds, the given amount of frames represents.
 | 
			
		||||
  /// @param frames Number of audio frames
 | 
			
		||||
  /// @return Duration in microseconds `frames` respresents. May be slightly inaccurate due to integer divison rounding
 | 
			
		||||
  ///         for certain sample rates.
 | 
			
		||||
  uint32_t frames_to_microseconds(uint32_t frames) const;
 | 
			
		||||
 | 
			
		||||
  /// @brief Computes the duration, in milliseconds, the given amount of frames represents. Avoids
 | 
			
		||||
  /// accumulating rounding errors by updating `frames` with the remainder after converting.
 | 
			
		||||
  /// @param frames Pointer to uint32_t with the number of audio frames. Replaced with the remainder.
 | 
			
		||||
  /// @return Duration in milliseconds `frames` represents. Always less than or equal to the actual value due to
 | 
			
		||||
  ///         rounding.
 | 
			
		||||
  uint32_t frames_to_milliseconds_with_remainder(uint32_t *frames) const;
 | 
			
		||||
 | 
			
		||||
  // Class comparison operators
 | 
			
		||||
  bool operator==(const AudioStreamInfo &rhs) const;
 | 
			
		||||
  bool operator!=(const AudioStreamInfo &rhs) const { return !operator==(rhs); }
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  uint8_t bits_per_sample_;
 | 
			
		||||
  uint8_t channels_;
 | 
			
		||||
  uint32_t sample_rate_;
 | 
			
		||||
 | 
			
		||||
  // The greatest common divisor between 1000 ms = 1 second and the sample rate. Used to avoid accumulating error when
 | 
			
		||||
  // converting from frames to duration. Computed at construction.
 | 
			
		||||
  uint32_t ms_sample_rate_gcd_;
 | 
			
		||||
 | 
			
		||||
  // Conversion factor derived from the number of bits per sample. Assumes audio data is aligned to the byte. Computed
 | 
			
		||||
  // at construction.
 | 
			
		||||
  size_t bytes_per_sample_;
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
enum class AudioFileType : uint8_t {
 | 
			
		||||
  NONE = 0,
 | 
			
		||||
#ifdef USE_AUDIO_FLAC_SUPPORT
 | 
			
		||||
  FLAC,
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_AUDIO_MP3_SUPPORT
 | 
			
		||||
  MP3,
 | 
			
		||||
#endif
 | 
			
		||||
  WAV,
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
struct AudioFile {
 | 
			
		||||
  const uint8_t *data;
 | 
			
		||||
  size_t length;
 | 
			
		||||
  AudioFileType file_type;
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
/// @brief Helper function to convert file type to a const char string
 | 
			
		||||
/// @param file_type
 | 
			
		||||
/// @return const char pointer to the readable file type
 | 
			
		||||
const char *audio_file_type_to_string(AudioFileType file_type);
 | 
			
		||||
 | 
			
		||||
/// @brief Scales Q15 fixed point audio samples. Scales in place if audio_samples == output_buffer.
 | 
			
		||||
/// @param audio_samples PCM int16 audio samples
 | 
			
		||||
/// @param output_buffer Buffer to store the scaled samples
 | 
			
		||||
/// @param scale_factor Q15 fixed point scaling factor
 | 
			
		||||
/// @param samples_to_scale Number of samples to scale
 | 
			
		||||
void scale_audio_samples(const int16_t *audio_samples, int16_t *output_buffer, int16_t scale_factor,
 | 
			
		||||
                         size_t samples_to_scale);
 | 
			
		||||
 | 
			
		||||
}  // namespace audio
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
@@ -1,361 +0,0 @@
 | 
			
		||||
#include "audio_decoder.h"
 | 
			
		||||
 | 
			
		||||
#ifdef USE_ESP32
 | 
			
		||||
 | 
			
		||||
#include "esphome/core/hal.h"
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace audio {
 | 
			
		||||
 | 
			
		||||
static const uint32_t DECODING_TIMEOUT_MS = 50;    // The decode function will yield after this duration
 | 
			
		||||
static const uint32_t READ_WRITE_TIMEOUT_MS = 20;  // Timeout for transferring audio data
 | 
			
		||||
 | 
			
		||||
static const uint32_t MAX_POTENTIALLY_FAILED_COUNT = 10;
 | 
			
		||||
 | 
			
		||||
AudioDecoder::AudioDecoder(size_t input_buffer_size, size_t output_buffer_size) {
 | 
			
		||||
  this->input_transfer_buffer_ = AudioSourceTransferBuffer::create(input_buffer_size);
 | 
			
		||||
  this->output_transfer_buffer_ = AudioSinkTransferBuffer::create(output_buffer_size);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
AudioDecoder::~AudioDecoder() {
 | 
			
		||||
#ifdef USE_AUDIO_MP3_SUPPORT
 | 
			
		||||
  if (this->audio_file_type_ == AudioFileType::MP3) {
 | 
			
		||||
    esp_audio_libs::helix_decoder::MP3FreeDecoder(this->mp3_decoder_);
 | 
			
		||||
  }
 | 
			
		||||
#endif
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
esp_err_t AudioDecoder::add_source(std::weak_ptr<RingBuffer> &input_ring_buffer) {
 | 
			
		||||
  if (this->input_transfer_buffer_ != nullptr) {
 | 
			
		||||
    this->input_transfer_buffer_->set_source(input_ring_buffer);
 | 
			
		||||
    return ESP_OK;
 | 
			
		||||
  }
 | 
			
		||||
  return ESP_ERR_NO_MEM;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
esp_err_t AudioDecoder::add_sink(std::weak_ptr<RingBuffer> &output_ring_buffer) {
 | 
			
		||||
  if (this->output_transfer_buffer_ != nullptr) {
 | 
			
		||||
    this->output_transfer_buffer_->set_sink(output_ring_buffer);
 | 
			
		||||
    return ESP_OK;
 | 
			
		||||
  }
 | 
			
		||||
  return ESP_ERR_NO_MEM;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
#ifdef USE_SPEAKER
 | 
			
		||||
esp_err_t AudioDecoder::add_sink(speaker::Speaker *speaker) {
 | 
			
		||||
  if (this->output_transfer_buffer_ != nullptr) {
 | 
			
		||||
    this->output_transfer_buffer_->set_sink(speaker);
 | 
			
		||||
    return ESP_OK;
 | 
			
		||||
  }
 | 
			
		||||
  return ESP_ERR_NO_MEM;
 | 
			
		||||
}
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
esp_err_t AudioDecoder::start(AudioFileType audio_file_type) {
 | 
			
		||||
  if ((this->input_transfer_buffer_ == nullptr) || (this->output_transfer_buffer_ == nullptr)) {
 | 
			
		||||
    return ESP_ERR_NO_MEM;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  this->audio_file_type_ = audio_file_type;
 | 
			
		||||
 | 
			
		||||
  this->potentially_failed_count_ = 0;
 | 
			
		||||
  this->end_of_file_ = false;
 | 
			
		||||
 | 
			
		||||
  switch (this->audio_file_type_) {
 | 
			
		||||
#ifdef USE_AUDIO_FLAC_SUPPORT
 | 
			
		||||
    case AudioFileType::FLAC:
 | 
			
		||||
      this->flac_decoder_ = make_unique<esp_audio_libs::flac::FLACDecoder>();
 | 
			
		||||
      this->free_buffer_required_ =
 | 
			
		||||
          this->output_transfer_buffer_->capacity();  // We'll revise this after reading the header
 | 
			
		||||
      break;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_AUDIO_MP3_SUPPORT
 | 
			
		||||
    case AudioFileType::MP3:
 | 
			
		||||
      this->mp3_decoder_ = esp_audio_libs::helix_decoder::MP3InitDecoder();
 | 
			
		||||
      this->free_buffer_required_ = 1152 * sizeof(int16_t) * 2;  // samples * size per sample * channels
 | 
			
		||||
      break;
 | 
			
		||||
#endif
 | 
			
		||||
    case AudioFileType::WAV:
 | 
			
		||||
      this->wav_decoder_ = make_unique<esp_audio_libs::wav_decoder::WAVDecoder>();
 | 
			
		||||
      this->wav_decoder_->reset();
 | 
			
		||||
      this->free_buffer_required_ = 1024;
 | 
			
		||||
      break;
 | 
			
		||||
    case AudioFileType::NONE:
 | 
			
		||||
    default:
 | 
			
		||||
      return ESP_ERR_NOT_SUPPORTED;
 | 
			
		||||
      break;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  return ESP_OK;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
AudioDecoderState AudioDecoder::decode(bool stop_gracefully) {
 | 
			
		||||
  if (stop_gracefully) {
 | 
			
		||||
    if (this->output_transfer_buffer_->available() == 0) {
 | 
			
		||||
      if (this->end_of_file_) {
 | 
			
		||||
        // The file decoder indicates it reached the end of file
 | 
			
		||||
        return AudioDecoderState::FINISHED;
 | 
			
		||||
      }
 | 
			
		||||
 | 
			
		||||
      if (!this->input_transfer_buffer_->has_buffered_data()) {
 | 
			
		||||
        // If all the internal buffers are empty, the decoding is done
 | 
			
		||||
        return AudioDecoderState::FINISHED;
 | 
			
		||||
      }
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  if (this->potentially_failed_count_ > MAX_POTENTIALLY_FAILED_COUNT) {
 | 
			
		||||
    if (stop_gracefully) {
 | 
			
		||||
      // No more new data is going to come in, so decoding is done
 | 
			
		||||
      return AudioDecoderState::FINISHED;
 | 
			
		||||
    }
 | 
			
		||||
    return AudioDecoderState::FAILED;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  FileDecoderState state = FileDecoderState::MORE_TO_PROCESS;
 | 
			
		||||
 | 
			
		||||
  uint32_t decoding_start = millis();
 | 
			
		||||
 | 
			
		||||
  while (state == FileDecoderState::MORE_TO_PROCESS) {
 | 
			
		||||
    // Transfer decoded out
 | 
			
		||||
    if (!this->pause_output_) {
 | 
			
		||||
      size_t bytes_written = this->output_transfer_buffer_->transfer_data_to_sink(pdMS_TO_TICKS(READ_WRITE_TIMEOUT_MS));
 | 
			
		||||
      if (this->audio_stream_info_.has_value()) {
 | 
			
		||||
        this->accumulated_frames_written_ += this->audio_stream_info_.value().bytes_to_frames(bytes_written);
 | 
			
		||||
        this->playback_ms_ +=
 | 
			
		||||
            this->audio_stream_info_.value().frames_to_milliseconds_with_remainder(&this->accumulated_frames_written_);
 | 
			
		||||
      }
 | 
			
		||||
    } else {
 | 
			
		||||
      // If paused, block to avoid wasting CPU resources
 | 
			
		||||
      delay(READ_WRITE_TIMEOUT_MS);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Verify there is enough space to store more decoded audio and that the function hasn't been running too long
 | 
			
		||||
    if ((this->output_transfer_buffer_->free() < this->free_buffer_required_) ||
 | 
			
		||||
        (millis() - decoding_start > DECODING_TIMEOUT_MS)) {
 | 
			
		||||
      return AudioDecoderState::DECODING;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Decode more audio
 | 
			
		||||
 | 
			
		||||
    size_t bytes_read = this->input_transfer_buffer_->transfer_data_from_source(pdMS_TO_TICKS(READ_WRITE_TIMEOUT_MS));
 | 
			
		||||
 | 
			
		||||
    if ((this->potentially_failed_count_ > 0) && (bytes_read == 0)) {
 | 
			
		||||
      // Failed to decode in last attempt and there is no new data
 | 
			
		||||
 | 
			
		||||
      if (this->input_transfer_buffer_->free() == 0) {
 | 
			
		||||
        // The input buffer is full. Since it previously failed on the exact same data, we can never recover
 | 
			
		||||
        state = FileDecoderState::FAILED;
 | 
			
		||||
      } else {
 | 
			
		||||
        // Attempt to get more data next time
 | 
			
		||||
        state = FileDecoderState::IDLE;
 | 
			
		||||
      }
 | 
			
		||||
    } else if (this->input_transfer_buffer_->available() == 0) {
 | 
			
		||||
      // No data to decode, attempt to get more data next time
 | 
			
		||||
      state = FileDecoderState::IDLE;
 | 
			
		||||
    } else {
 | 
			
		||||
      switch (this->audio_file_type_) {
 | 
			
		||||
#ifdef USE_AUDIO_FLAC_SUPPORT
 | 
			
		||||
        case AudioFileType::FLAC:
 | 
			
		||||
          state = this->decode_flac_();
 | 
			
		||||
          break;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_AUDIO_MP3_SUPPORT
 | 
			
		||||
        case AudioFileType::MP3:
 | 
			
		||||
          state = this->decode_mp3_();
 | 
			
		||||
          break;
 | 
			
		||||
#endif
 | 
			
		||||
        case AudioFileType::WAV:
 | 
			
		||||
          state = this->decode_wav_();
 | 
			
		||||
          break;
 | 
			
		||||
        case AudioFileType::NONE:
 | 
			
		||||
        default:
 | 
			
		||||
          state = FileDecoderState::IDLE;
 | 
			
		||||
          break;
 | 
			
		||||
      }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    if (state == FileDecoderState::POTENTIALLY_FAILED) {
 | 
			
		||||
      ++this->potentially_failed_count_;
 | 
			
		||||
    } else if (state == FileDecoderState::END_OF_FILE) {
 | 
			
		||||
      this->end_of_file_ = true;
 | 
			
		||||
    } else if (state == FileDecoderState::FAILED) {
 | 
			
		||||
      return AudioDecoderState::FAILED;
 | 
			
		||||
    } else if (state == FileDecoderState::MORE_TO_PROCESS) {
 | 
			
		||||
      this->potentially_failed_count_ = 0;
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
  return AudioDecoderState::DECODING;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
#ifdef USE_AUDIO_FLAC_SUPPORT
 | 
			
		||||
FileDecoderState AudioDecoder::decode_flac_() {
 | 
			
		||||
  if (!this->audio_stream_info_.has_value()) {
 | 
			
		||||
    // Header hasn't been read
 | 
			
		||||
    auto result = this->flac_decoder_->read_header(this->input_transfer_buffer_->get_buffer_start(),
 | 
			
		||||
                                                   this->input_transfer_buffer_->available());
 | 
			
		||||
 | 
			
		||||
    if (result == esp_audio_libs::flac::FLAC_DECODER_HEADER_OUT_OF_DATA) {
 | 
			
		||||
      return FileDecoderState::POTENTIALLY_FAILED;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    if (result != esp_audio_libs::flac::FLAC_DECODER_SUCCESS) {
 | 
			
		||||
      // Couldn't read FLAC header
 | 
			
		||||
      return FileDecoderState::FAILED;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    size_t bytes_consumed = this->flac_decoder_->get_bytes_index();
 | 
			
		||||
    this->input_transfer_buffer_->decrease_buffer_length(bytes_consumed);
 | 
			
		||||
 | 
			
		||||
    this->free_buffer_required_ = flac_decoder_->get_output_buffer_size_bytes();
 | 
			
		||||
    if (this->output_transfer_buffer_->capacity() < this->free_buffer_required_) {
 | 
			
		||||
      // Output buffer is not big enough
 | 
			
		||||
      if (!this->output_transfer_buffer_->reallocate(this->free_buffer_required_)) {
 | 
			
		||||
        // Couldn't reallocate output buffer
 | 
			
		||||
        return FileDecoderState::FAILED;
 | 
			
		||||
      }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    this->audio_stream_info_ =
 | 
			
		||||
        audio::AudioStreamInfo(this->flac_decoder_->get_sample_depth(), this->flac_decoder_->get_num_channels(),
 | 
			
		||||
                               this->flac_decoder_->get_sample_rate());
 | 
			
		||||
 | 
			
		||||
    return FileDecoderState::MORE_TO_PROCESS;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  uint32_t output_samples = 0;
 | 
			
		||||
  auto result = this->flac_decoder_->decode_frame(
 | 
			
		||||
      this->input_transfer_buffer_->get_buffer_start(), this->input_transfer_buffer_->available(),
 | 
			
		||||
      reinterpret_cast<int16_t *>(this->output_transfer_buffer_->get_buffer_end()), &output_samples);
 | 
			
		||||
 | 
			
		||||
  if (result == esp_audio_libs::flac::FLAC_DECODER_ERROR_OUT_OF_DATA) {
 | 
			
		||||
    // Not an issue, just needs more data that we'll get next time.
 | 
			
		||||
    return FileDecoderState::POTENTIALLY_FAILED;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  size_t bytes_consumed = this->flac_decoder_->get_bytes_index();
 | 
			
		||||
  this->input_transfer_buffer_->decrease_buffer_length(bytes_consumed);
 | 
			
		||||
 | 
			
		||||
  if (result > esp_audio_libs::flac::FLAC_DECODER_ERROR_OUT_OF_DATA) {
 | 
			
		||||
    // Corrupted frame, don't retry with current buffer content, wait for new sync
 | 
			
		||||
    return FileDecoderState::POTENTIALLY_FAILED;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // We have successfully decoded some input data and have new output data
 | 
			
		||||
  this->output_transfer_buffer_->increase_buffer_length(
 | 
			
		||||
      this->audio_stream_info_.value().samples_to_bytes(output_samples));
 | 
			
		||||
 | 
			
		||||
  if (result == esp_audio_libs::flac::FLAC_DECODER_NO_MORE_FRAMES) {
 | 
			
		||||
    return FileDecoderState::END_OF_FILE;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  return FileDecoderState::MORE_TO_PROCESS;
 | 
			
		||||
}
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_AUDIO_MP3_SUPPORT
 | 
			
		||||
FileDecoderState AudioDecoder::decode_mp3_() {
 | 
			
		||||
  // Look for the next sync word
 | 
			
		||||
  int buffer_length = (int) this->input_transfer_buffer_->available();
 | 
			
		||||
  int32_t offset =
 | 
			
		||||
      esp_audio_libs::helix_decoder::MP3FindSyncWord(this->input_transfer_buffer_->get_buffer_start(), buffer_length);
 | 
			
		||||
 | 
			
		||||
  if (offset < 0) {
 | 
			
		||||
    // New data may have the sync word
 | 
			
		||||
    this->input_transfer_buffer_->decrease_buffer_length(buffer_length);
 | 
			
		||||
    return FileDecoderState::POTENTIALLY_FAILED;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // Advance read pointer to match the offset for the syncword
 | 
			
		||||
  this->input_transfer_buffer_->decrease_buffer_length(offset);
 | 
			
		||||
  uint8_t *buffer_start = this->input_transfer_buffer_->get_buffer_start();
 | 
			
		||||
 | 
			
		||||
  buffer_length = (int) this->input_transfer_buffer_->available();
 | 
			
		||||
  int err = esp_audio_libs::helix_decoder::MP3Decode(this->mp3_decoder_, &buffer_start, &buffer_length,
 | 
			
		||||
                                                     (int16_t *) this->output_transfer_buffer_->get_buffer_end(), 0);
 | 
			
		||||
 | 
			
		||||
  size_t consumed = this->input_transfer_buffer_->available() - buffer_length;
 | 
			
		||||
  this->input_transfer_buffer_->decrease_buffer_length(consumed);
 | 
			
		||||
 | 
			
		||||
  if (err) {
 | 
			
		||||
    switch (err) {
 | 
			
		||||
      case esp_audio_libs::helix_decoder::ERR_MP3_OUT_OF_MEMORY:
 | 
			
		||||
        // Intentional fallthrough
 | 
			
		||||
      case esp_audio_libs::helix_decoder::ERR_MP3_NULL_POINTER:
 | 
			
		||||
        return FileDecoderState::FAILED;
 | 
			
		||||
        break;
 | 
			
		||||
      default:
 | 
			
		||||
        // Most errors are recoverable by moving on to the next frame, so mark as potentailly failed
 | 
			
		||||
        return FileDecoderState::POTENTIALLY_FAILED;
 | 
			
		||||
        break;
 | 
			
		||||
    }
 | 
			
		||||
  } else {
 | 
			
		||||
    esp_audio_libs::helix_decoder::MP3FrameInfo mp3_frame_info;
 | 
			
		||||
    esp_audio_libs::helix_decoder::MP3GetLastFrameInfo(this->mp3_decoder_, &mp3_frame_info);
 | 
			
		||||
    if (mp3_frame_info.outputSamps > 0) {
 | 
			
		||||
      int bytes_per_sample = (mp3_frame_info.bitsPerSample / 8);
 | 
			
		||||
      this->output_transfer_buffer_->increase_buffer_length(mp3_frame_info.outputSamps * bytes_per_sample);
 | 
			
		||||
 | 
			
		||||
      if (!this->audio_stream_info_.has_value()) {
 | 
			
		||||
        this->audio_stream_info_ =
 | 
			
		||||
            audio::AudioStreamInfo(mp3_frame_info.bitsPerSample, mp3_frame_info.nChans, mp3_frame_info.samprate);
 | 
			
		||||
      }
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  return FileDecoderState::MORE_TO_PROCESS;
 | 
			
		||||
}
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
FileDecoderState AudioDecoder::decode_wav_() {
 | 
			
		||||
  if (!this->audio_stream_info_.has_value()) {
 | 
			
		||||
    // Header hasn't been processed
 | 
			
		||||
 | 
			
		||||
    esp_audio_libs::wav_decoder::WAVDecoderResult result = this->wav_decoder_->decode_header(
 | 
			
		||||
        this->input_transfer_buffer_->get_buffer_start(), this->input_transfer_buffer_->available());
 | 
			
		||||
 | 
			
		||||
    if (result == esp_audio_libs::wav_decoder::WAV_DECODER_SUCCESS_IN_DATA) {
 | 
			
		||||
      this->input_transfer_buffer_->decrease_buffer_length(this->wav_decoder_->bytes_processed());
 | 
			
		||||
 | 
			
		||||
      this->audio_stream_info_ = audio::AudioStreamInfo(
 | 
			
		||||
          this->wav_decoder_->bits_per_sample(), this->wav_decoder_->num_channels(), this->wav_decoder_->sample_rate());
 | 
			
		||||
 | 
			
		||||
      this->wav_bytes_left_ = this->wav_decoder_->chunk_bytes_left();
 | 
			
		||||
      this->wav_has_known_end_ = (this->wav_bytes_left_ > 0);
 | 
			
		||||
      return FileDecoderState::MORE_TO_PROCESS;
 | 
			
		||||
    } else if (result == esp_audio_libs::wav_decoder::WAV_DECODER_WARNING_INCOMPLETE_DATA) {
 | 
			
		||||
      // Available data didn't have the full header
 | 
			
		||||
      return FileDecoderState::POTENTIALLY_FAILED;
 | 
			
		||||
    } else {
 | 
			
		||||
      return FileDecoderState::FAILED;
 | 
			
		||||
    }
 | 
			
		||||
  } else {
 | 
			
		||||
    if (!this->wav_has_known_end_ || (this->wav_bytes_left_ > 0)) {
 | 
			
		||||
      size_t bytes_to_copy = this->input_transfer_buffer_->available();
 | 
			
		||||
 | 
			
		||||
      if (this->wav_has_known_end_) {
 | 
			
		||||
        bytes_to_copy = std::min(bytes_to_copy, this->wav_bytes_left_);
 | 
			
		||||
      }
 | 
			
		||||
 | 
			
		||||
      bytes_to_copy = std::min(bytes_to_copy, this->output_transfer_buffer_->free());
 | 
			
		||||
 | 
			
		||||
      if (bytes_to_copy > 0) {
 | 
			
		||||
        std::memcpy(this->output_transfer_buffer_->get_buffer_end(), this->input_transfer_buffer_->get_buffer_start(),
 | 
			
		||||
                    bytes_to_copy);
 | 
			
		||||
        this->input_transfer_buffer_->decrease_buffer_length(bytes_to_copy);
 | 
			
		||||
        this->output_transfer_buffer_->increase_buffer_length(bytes_to_copy);
 | 
			
		||||
        if (this->wav_has_known_end_) {
 | 
			
		||||
          this->wav_bytes_left_ -= bytes_to_copy;
 | 
			
		||||
        }
 | 
			
		||||
      }
 | 
			
		||||
      return FileDecoderState::IDLE;
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  return FileDecoderState::END_OF_FILE;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
}  // namespace audio
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
 | 
			
		||||
#endif
 | 
			
		||||
@@ -1,135 +0,0 @@
 | 
			
		||||
#pragma once
 | 
			
		||||
 | 
			
		||||
#ifdef USE_ESP32
 | 
			
		||||
 | 
			
		||||
#include "audio.h"
 | 
			
		||||
#include "audio_transfer_buffer.h"
 | 
			
		||||
 | 
			
		||||
#include "esphome/core/defines.h"
 | 
			
		||||
#include "esphome/core/helpers.h"
 | 
			
		||||
#include "esphome/core/ring_buffer.h"
 | 
			
		||||
 | 
			
		||||
#ifdef USE_SPEAKER
 | 
			
		||||
#include "esphome/components/speaker/speaker.h"
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#include "esp_err.h"
 | 
			
		||||
 | 
			
		||||
// esp-audio-libs
 | 
			
		||||
#ifdef USE_AUDIO_FLAC_SUPPORT
 | 
			
		||||
#include <flac_decoder.h>
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_AUDIO_MP3_SUPPORT
 | 
			
		||||
#include <mp3_decoder.h>
 | 
			
		||||
#endif
 | 
			
		||||
#include <wav_decoder.h>
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace audio {
 | 
			
		||||
 | 
			
		||||
enum class AudioDecoderState : uint8_t {
 | 
			
		||||
  DECODING = 0,  // More data is available to decode
 | 
			
		||||
  FINISHED,      // All file data has been decoded and transferred
 | 
			
		||||
  FAILED,        // Encountered an error
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
// Only used within the AudioDecoder class; conveys the state of the particular file type decoder
 | 
			
		||||
enum class FileDecoderState : uint8_t {
 | 
			
		||||
  MORE_TO_PROCESS,     // Successsfully read a file chunk and more data is available to decode
 | 
			
		||||
  IDLE,                // Not enough data to decode, waiting for more to be transferred
 | 
			
		||||
  POTENTIALLY_FAILED,  // Decoder encountered a potentially recoverable error if more file data is available
 | 
			
		||||
  FAILED,              // Decoder encoutnered an uncrecoverable error
 | 
			
		||||
  END_OF_FILE,         // The specific file decoder knows its the end of the file
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
class AudioDecoder {
 | 
			
		||||
  /*
 | 
			
		||||
   * @brief Class that facilitates decoding an audio file.
 | 
			
		||||
   * The audio file is read from a ring buffer source, decoded, and sent to an audio sink (ring buffer or speaker
 | 
			
		||||
   * component).
 | 
			
		||||
   * Supports wav, flac, and mp3 formats.
 | 
			
		||||
   */
 | 
			
		||||
 public:
 | 
			
		||||
  /// @brief Allocates the input and output transfer buffers
 | 
			
		||||
  /// @param input_buffer_size Size of the input transfer buffer in bytes.
 | 
			
		||||
  /// @param output_buffer_size Size of the output transfer buffer in bytes.
 | 
			
		||||
  AudioDecoder(size_t input_buffer_size, size_t output_buffer_size);
 | 
			
		||||
 | 
			
		||||
  /// @brief Deallocates the MP3 decoder (the flac and wav decoders are deallocated automatically)
 | 
			
		||||
  ~AudioDecoder();
 | 
			
		||||
 | 
			
		||||
  /// @brief Adds a source ring buffer for raw file data. Takes ownership of the ring buffer in a shared_ptr.
 | 
			
		||||
  /// @param input_ring_buffer weak_ptr of a shared_ptr of the sink ring buffer to transfer ownership
 | 
			
		||||
  /// @return ESP_OK if successsful, ESP_ERR_NO_MEM if the transfer buffer wasn't allocated
 | 
			
		||||
  esp_err_t add_source(std::weak_ptr<RingBuffer> &input_ring_buffer);
 | 
			
		||||
 | 
			
		||||
  /// @brief Adds a sink ring buffer for decoded audio. Takes ownership of the ring buffer in a shared_ptr.
 | 
			
		||||
  /// @param output_ring_buffer weak_ptr of a shared_ptr of the sink ring buffer to transfer ownership
 | 
			
		||||
  /// @return ESP_OK if successsful, ESP_ERR_NO_MEM if the transfer buffer wasn't allocated
 | 
			
		||||
  esp_err_t add_sink(std::weak_ptr<RingBuffer> &output_ring_buffer);
 | 
			
		||||
 | 
			
		||||
#ifdef USE_SPEAKER
 | 
			
		||||
  /// @brief Adds a sink speaker for decoded audio.
 | 
			
		||||
  /// @param speaker pointer to speaker component
 | 
			
		||||
  /// @return ESP_OK if successsful, ESP_ERR_NO_MEM if the transfer buffer wasn't allocated
 | 
			
		||||
  esp_err_t add_sink(speaker::Speaker *speaker);
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
  /// @brief Sets up decoding the file
 | 
			
		||||
  /// @param audio_file_type AudioFileType of the file
 | 
			
		||||
  /// @return ESP_OK if successful, ESP_ERR_NO_MEM if the transfer buffers fail to allocate, or ESP_ERR_NOT_SUPPORTED if
 | 
			
		||||
  /// the format isn't supported.
 | 
			
		||||
  esp_err_t start(AudioFileType audio_file_type);
 | 
			
		||||
 | 
			
		||||
  /// @brief Decodes audio from the ring buffer source and writes to the sink.
 | 
			
		||||
  /// @param stop_gracefully If true, it indicates the file source is finished. The decoder will decode all the
 | 
			
		||||
  /// reamining data and then finish.
 | 
			
		||||
  /// @return AudioDecoderState
 | 
			
		||||
  AudioDecoderState decode(bool stop_gracefully);
 | 
			
		||||
 | 
			
		||||
  /// @brief Gets the audio stream information, if it has been decoded from the files header
 | 
			
		||||
  /// @return optional<AudioStreamInfo> with the audio information. If not available yet, returns no value.
 | 
			
		||||
  const optional<audio::AudioStreamInfo> &get_audio_stream_info() const { return this->audio_stream_info_; }
 | 
			
		||||
 | 
			
		||||
  /// @brief Returns the duration of audio (in milliseconds) decoded and sent to the sink
 | 
			
		||||
  /// @return Duration of decoded audio in milliseconds
 | 
			
		||||
  uint32_t get_playback_ms() const { return this->playback_ms_; }
 | 
			
		||||
 | 
			
		||||
  /// @brief Pauses sending resampled audio to the sink. If paused, it will continue to process internal buffers.
 | 
			
		||||
  /// @param pause_state If true, audio data is not sent to the sink.
 | 
			
		||||
  void set_pause_output_state(bool pause_state) { this->pause_output_ = pause_state; }
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  std::unique_ptr<esp_audio_libs::wav_decoder::WAVDecoder> wav_decoder_;
 | 
			
		||||
#ifdef USE_AUDIO_FLAC_SUPPORT
 | 
			
		||||
  FileDecoderState decode_flac_();
 | 
			
		||||
  std::unique_ptr<esp_audio_libs::flac::FLACDecoder> flac_decoder_;
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_AUDIO_MP3_SUPPORT
 | 
			
		||||
  FileDecoderState decode_mp3_();
 | 
			
		||||
  esp_audio_libs::helix_decoder::HMP3Decoder mp3_decoder_;
 | 
			
		||||
#endif
 | 
			
		||||
  FileDecoderState decode_wav_();
 | 
			
		||||
 | 
			
		||||
  std::unique_ptr<AudioSourceTransferBuffer> input_transfer_buffer_;
 | 
			
		||||
  std::unique_ptr<AudioSinkTransferBuffer> output_transfer_buffer_;
 | 
			
		||||
 | 
			
		||||
  AudioFileType audio_file_type_{AudioFileType::NONE};
 | 
			
		||||
  optional<AudioStreamInfo> audio_stream_info_{};
 | 
			
		||||
 | 
			
		||||
  size_t free_buffer_required_{0};
 | 
			
		||||
  size_t wav_bytes_left_{0};
 | 
			
		||||
 | 
			
		||||
  uint32_t potentially_failed_count_{0};
 | 
			
		||||
  bool end_of_file_{false};
 | 
			
		||||
  bool wav_has_known_end_{false};
 | 
			
		||||
 | 
			
		||||
  bool pause_output_{false};
 | 
			
		||||
 | 
			
		||||
  uint32_t accumulated_frames_written_{0};
 | 
			
		||||
  uint32_t playback_ms_{0};
 | 
			
		||||
};
 | 
			
		||||
}  // namespace audio
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
 | 
			
		||||
#endif
 | 
			
		||||
@@ -1,308 +0,0 @@
 | 
			
		||||
#include "audio_reader.h"
 | 
			
		||||
 | 
			
		||||
#ifdef USE_ESP_IDF
 | 
			
		||||
 | 
			
		||||
#include "esphome/core/defines.h"
 | 
			
		||||
#include "esphome/core/hal.h"
 | 
			
		||||
#include "esphome/core/helpers.h"
 | 
			
		||||
 | 
			
		||||
#if CONFIG_MBEDTLS_CERTIFICATE_BUNDLE
 | 
			
		||||
#include "esp_crt_bundle.h"
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace audio {
 | 
			
		||||
 | 
			
		||||
static const uint32_t READ_WRITE_TIMEOUT_MS = 20;
 | 
			
		||||
 | 
			
		||||
static const uint32_t CONNECTION_TIMEOUT_MS = 5000;
 | 
			
		||||
 | 
			
		||||
// The number of times the http read times out with no data before throwing an error
 | 
			
		||||
static const uint32_t ERROR_COUNT_NO_DATA_READ_TIMEOUT = 100;
 | 
			
		||||
 | 
			
		||||
static const size_t HTTP_STREAM_BUFFER_SIZE = 2048;
 | 
			
		||||
 | 
			
		||||
static const uint8_t MAX_REDIRECTION = 5;
 | 
			
		||||
 | 
			
		||||
// Some common HTTP status codes - borrowed from http_request component accessed 20241224
 | 
			
		||||
enum HttpStatus {
 | 
			
		||||
  HTTP_STATUS_OK = 200,
 | 
			
		||||
  HTTP_STATUS_NO_CONTENT = 204,
 | 
			
		||||
  HTTP_STATUS_PARTIAL_CONTENT = 206,
 | 
			
		||||
 | 
			
		||||
  /* 3xx - Redirection */
 | 
			
		||||
  HTTP_STATUS_MULTIPLE_CHOICES = 300,
 | 
			
		||||
  HTTP_STATUS_MOVED_PERMANENTLY = 301,
 | 
			
		||||
  HTTP_STATUS_FOUND = 302,
 | 
			
		||||
  HTTP_STATUS_SEE_OTHER = 303,
 | 
			
		||||
  HTTP_STATUS_NOT_MODIFIED = 304,
 | 
			
		||||
  HTTP_STATUS_TEMPORARY_REDIRECT = 307,
 | 
			
		||||
  HTTP_STATUS_PERMANENT_REDIRECT = 308,
 | 
			
		||||
 | 
			
		||||
  /* 4XX - CLIENT ERROR */
 | 
			
		||||
  HTTP_STATUS_BAD_REQUEST = 400,
 | 
			
		||||
  HTTP_STATUS_UNAUTHORIZED = 401,
 | 
			
		||||
  HTTP_STATUS_FORBIDDEN = 403,
 | 
			
		||||
  HTTP_STATUS_NOT_FOUND = 404,
 | 
			
		||||
  HTTP_STATUS_METHOD_NOT_ALLOWED = 405,
 | 
			
		||||
  HTTP_STATUS_NOT_ACCEPTABLE = 406,
 | 
			
		||||
  HTTP_STATUS_LENGTH_REQUIRED = 411,
 | 
			
		||||
 | 
			
		||||
  /* 5xx - Server Error */
 | 
			
		||||
  HTTP_STATUS_INTERNAL_ERROR = 500
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
AudioReader::~AudioReader() { this->cleanup_connection_(); }
 | 
			
		||||
 | 
			
		||||
esp_err_t AudioReader::add_sink(const std::weak_ptr<RingBuffer> &output_ring_buffer) {
 | 
			
		||||
  if (current_audio_file_ != nullptr) {
 | 
			
		||||
    // A transfer buffer isn't ncessary for a local file
 | 
			
		||||
    this->file_ring_buffer_ = output_ring_buffer.lock();
 | 
			
		||||
    return ESP_OK;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  if (this->output_transfer_buffer_ != nullptr) {
 | 
			
		||||
    this->output_transfer_buffer_->set_sink(output_ring_buffer);
 | 
			
		||||
    return ESP_OK;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  return ESP_ERR_INVALID_STATE;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
esp_err_t AudioReader::start(AudioFile *audio_file, AudioFileType &file_type) {
 | 
			
		||||
  file_type = AudioFileType::NONE;
 | 
			
		||||
 | 
			
		||||
  this->current_audio_file_ = audio_file;
 | 
			
		||||
 | 
			
		||||
  this->file_current_ = audio_file->data;
 | 
			
		||||
  file_type = audio_file->file_type;
 | 
			
		||||
 | 
			
		||||
  return ESP_OK;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
esp_err_t AudioReader::start(const std::string &uri, AudioFileType &file_type) {
 | 
			
		||||
  file_type = AudioFileType::NONE;
 | 
			
		||||
 | 
			
		||||
  this->cleanup_connection_();
 | 
			
		||||
 | 
			
		||||
  if (uri.empty()) {
 | 
			
		||||
    return ESP_ERR_INVALID_ARG;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  esp_http_client_config_t client_config = {};
 | 
			
		||||
 | 
			
		||||
  client_config.url = uri.c_str();
 | 
			
		||||
  client_config.cert_pem = nullptr;
 | 
			
		||||
  client_config.disable_auto_redirect = false;
 | 
			
		||||
  client_config.max_redirection_count = 10;
 | 
			
		||||
  client_config.event_handler = http_event_handler;
 | 
			
		||||
  client_config.user_data = this;
 | 
			
		||||
  client_config.buffer_size = HTTP_STREAM_BUFFER_SIZE;
 | 
			
		||||
  client_config.keep_alive_enable = true;
 | 
			
		||||
  client_config.timeout_ms = CONNECTION_TIMEOUT_MS;  // Shouldn't trigger watchdog resets if caller runs in a task
 | 
			
		||||
 | 
			
		||||
#if CONFIG_MBEDTLS_CERTIFICATE_BUNDLE
 | 
			
		||||
  if (uri.find("https:") != std::string::npos) {
 | 
			
		||||
    client_config.crt_bundle_attach = esp_crt_bundle_attach;
 | 
			
		||||
  }
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
  this->client_ = esp_http_client_init(&client_config);
 | 
			
		||||
 | 
			
		||||
  if (this->client_ == nullptr) {
 | 
			
		||||
    return ESP_FAIL;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  esp_err_t err = esp_http_client_open(this->client_, 0);
 | 
			
		||||
 | 
			
		||||
  if (err != ESP_OK) {
 | 
			
		||||
    this->cleanup_connection_();
 | 
			
		||||
    return err;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  int64_t header_length = esp_http_client_fetch_headers(this->client_);
 | 
			
		||||
  if (header_length < 0) {
 | 
			
		||||
    this->cleanup_connection_();
 | 
			
		||||
    return ESP_FAIL;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  int status_code = esp_http_client_get_status_code(this->client_);
 | 
			
		||||
 | 
			
		||||
  if ((status_code < HTTP_STATUS_OK) || (status_code > HTTP_STATUS_PERMANENT_REDIRECT)) {
 | 
			
		||||
    this->cleanup_connection_();
 | 
			
		||||
    return ESP_FAIL;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  ssize_t redirect_count = 0;
 | 
			
		||||
 | 
			
		||||
  while ((esp_http_client_set_redirection(this->client_) == ESP_OK) && (redirect_count < MAX_REDIRECTION)) {
 | 
			
		||||
    err = esp_http_client_open(this->client_, 0);
 | 
			
		||||
    if (err != ESP_OK) {
 | 
			
		||||
      this->cleanup_connection_();
 | 
			
		||||
      return ESP_FAIL;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    header_length = esp_http_client_fetch_headers(this->client_);
 | 
			
		||||
    if (header_length < 0) {
 | 
			
		||||
      this->cleanup_connection_();
 | 
			
		||||
      return ESP_FAIL;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    status_code = esp_http_client_get_status_code(this->client_);
 | 
			
		||||
 | 
			
		||||
    if ((status_code < HTTP_STATUS_OK) || (status_code > HTTP_STATUS_PERMANENT_REDIRECT)) {
 | 
			
		||||
      this->cleanup_connection_();
 | 
			
		||||
      return ESP_FAIL;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    ++redirect_count;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  if (this->audio_file_type_ == AudioFileType::NONE) {
 | 
			
		||||
    // Failed to determine the file type from the header, fallback to using the url
 | 
			
		||||
    char url[500];
 | 
			
		||||
    err = esp_http_client_get_url(this->client_, url, 500);
 | 
			
		||||
    if (err != ESP_OK) {
 | 
			
		||||
      this->cleanup_connection_();
 | 
			
		||||
      return err;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    std::string url_string = str_lower_case(url);
 | 
			
		||||
 | 
			
		||||
    if (str_endswith(url_string, ".wav")) {
 | 
			
		||||
      file_type = AudioFileType::WAV;
 | 
			
		||||
    }
 | 
			
		||||
#ifdef USE_AUDIO_MP3_SUPPORT
 | 
			
		||||
    else if (str_endswith(url_string, ".mp3")) {
 | 
			
		||||
      file_type = AudioFileType::MP3;
 | 
			
		||||
    }
 | 
			
		||||
#endif
 | 
			
		||||
#ifdef USE_AUDIO_FLAC_SUPPORT
 | 
			
		||||
    else if (str_endswith(url_string, ".flac")) {
 | 
			
		||||
      file_type = AudioFileType::FLAC;
 | 
			
		||||
    }
 | 
			
		||||
#endif
 | 
			
		||||
    else {
 | 
			
		||||
      file_type = AudioFileType::NONE;
 | 
			
		||||
      this->cleanup_connection_();
 | 
			
		||||
      return ESP_ERR_NOT_SUPPORTED;
 | 
			
		||||
    }
 | 
			
		||||
  } else {
 | 
			
		||||
    file_type = this->audio_file_type_;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  this->last_data_read_ms_ = millis();
 | 
			
		||||
 | 
			
		||||
  this->output_transfer_buffer_ = AudioSinkTransferBuffer::create(this->buffer_size_);
 | 
			
		||||
  if (this->output_transfer_buffer_ == nullptr) {
 | 
			
		||||
    return ESP_ERR_NO_MEM;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  return ESP_OK;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
AudioReaderState AudioReader::read() {
 | 
			
		||||
  if (this->client_ != nullptr) {
 | 
			
		||||
    return this->http_read_();
 | 
			
		||||
  } else if (this->current_audio_file_ != nullptr) {
 | 
			
		||||
    return this->file_read_();
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  return AudioReaderState::FAILED;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
AudioFileType AudioReader::get_audio_type(const char *content_type) {
 | 
			
		||||
#ifdef USE_AUDIO_MP3_SUPPORT
 | 
			
		||||
  if (strcasecmp(content_type, "mp3") == 0 || strcasecmp(content_type, "audio/mp3") == 0 ||
 | 
			
		||||
      strcasecmp(content_type, "audio/mpeg") == 0) {
 | 
			
		||||
    return AudioFileType::MP3;
 | 
			
		||||
  }
 | 
			
		||||
#endif
 | 
			
		||||
  if (strcasecmp(content_type, "audio/wav") == 0) {
 | 
			
		||||
    return AudioFileType::WAV;
 | 
			
		||||
  }
 | 
			
		||||
#ifdef USE_AUDIO_FLAC_SUPPORT
 | 
			
		||||
  if (strcasecmp(content_type, "audio/flac") == 0 || strcasecmp(content_type, "audio/x-flac") == 0) {
 | 
			
		||||
    return AudioFileType::FLAC;
 | 
			
		||||
  }
 | 
			
		||||
#endif
 | 
			
		||||
  return AudioFileType::NONE;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
esp_err_t AudioReader::http_event_handler(esp_http_client_event_t *evt) {
 | 
			
		||||
  // Based on https://github.com/maroc81/WeatherLily/tree/main/main/net accessed 20241224
 | 
			
		||||
  AudioReader *this_reader = (AudioReader *) evt->user_data;
 | 
			
		||||
 | 
			
		||||
  switch (evt->event_id) {
 | 
			
		||||
    case HTTP_EVENT_ON_HEADER:
 | 
			
		||||
      if (strcasecmp(evt->header_key, "Content-Type") == 0) {
 | 
			
		||||
        this_reader->audio_file_type_ = get_audio_type(evt->header_value);
 | 
			
		||||
      }
 | 
			
		||||
      break;
 | 
			
		||||
    default:
 | 
			
		||||
      break;
 | 
			
		||||
  }
 | 
			
		||||
  return ESP_OK;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
AudioReaderState AudioReader::file_read_() {
 | 
			
		||||
  size_t remaining_bytes = this->current_audio_file_->length - (this->file_current_ - this->current_audio_file_->data);
 | 
			
		||||
  if (remaining_bytes > 0) {
 | 
			
		||||
    size_t bytes_written = this->file_ring_buffer_->write_without_replacement(this->file_current_, remaining_bytes,
 | 
			
		||||
                                                                              pdMS_TO_TICKS(READ_WRITE_TIMEOUT_MS));
 | 
			
		||||
    this->file_current_ += bytes_written;
 | 
			
		||||
 | 
			
		||||
    return AudioReaderState::READING;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  return AudioReaderState::FINISHED;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
AudioReaderState AudioReader::http_read_() {
 | 
			
		||||
  this->output_transfer_buffer_->transfer_data_to_sink(pdMS_TO_TICKS(READ_WRITE_TIMEOUT_MS));
 | 
			
		||||
 | 
			
		||||
  if (esp_http_client_is_complete_data_received(this->client_)) {
 | 
			
		||||
    if (this->output_transfer_buffer_->available() == 0) {
 | 
			
		||||
      this->cleanup_connection_();
 | 
			
		||||
      return AudioReaderState::FINISHED;
 | 
			
		||||
    }
 | 
			
		||||
  } else {
 | 
			
		||||
    size_t bytes_to_read = this->output_transfer_buffer_->free();
 | 
			
		||||
    int received_len =
 | 
			
		||||
        esp_http_client_read(this->client_, (char *) this->output_transfer_buffer_->get_buffer_end(), bytes_to_read);
 | 
			
		||||
 | 
			
		||||
    if (received_len > 0) {
 | 
			
		||||
      this->output_transfer_buffer_->increase_buffer_length(received_len);
 | 
			
		||||
      this->last_data_read_ms_ = millis();
 | 
			
		||||
    } else if (received_len < 0) {
 | 
			
		||||
      // HTTP read error
 | 
			
		||||
      this->cleanup_connection_();
 | 
			
		||||
      return AudioReaderState::FAILED;
 | 
			
		||||
    } else {
 | 
			
		||||
      if (bytes_to_read > 0) {
 | 
			
		||||
        // Read timed out
 | 
			
		||||
        if ((millis() - this->last_data_read_ms_) > CONNECTION_TIMEOUT_MS) {
 | 
			
		||||
          this->cleanup_connection_();
 | 
			
		||||
          return AudioReaderState::FAILED;
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        delay(READ_WRITE_TIMEOUT_MS);
 | 
			
		||||
      }
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  return AudioReaderState::READING;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void AudioReader::cleanup_connection_() {
 | 
			
		||||
  if (this->client_ != nullptr) {
 | 
			
		||||
    esp_http_client_close(this->client_);
 | 
			
		||||
    esp_http_client_cleanup(this->client_);
 | 
			
		||||
    this->client_ = nullptr;
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
}  // namespace audio
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
 | 
			
		||||
#endif
 | 
			
		||||
@@ -1,85 +0,0 @@
 | 
			
		||||
#pragma once
 | 
			
		||||
 | 
			
		||||
#ifdef USE_ESP_IDF
 | 
			
		||||
 | 
			
		||||
#include "audio.h"
 | 
			
		||||
#include "audio_transfer_buffer.h"
 | 
			
		||||
 | 
			
		||||
#include "esphome/core/ring_buffer.h"
 | 
			
		||||
 | 
			
		||||
#include "esp_err.h"
 | 
			
		||||
 | 
			
		||||
#include <esp_http_client.h>
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace audio {
 | 
			
		||||
 | 
			
		||||
enum class AudioReaderState : uint8_t {
 | 
			
		||||
  READING = 0,  // More data is available to read
 | 
			
		||||
  FINISHED,     // All data has been read and transferred
 | 
			
		||||
  FAILED,       // Encountered an error
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
class AudioReader {
 | 
			
		||||
  /*
 | 
			
		||||
   * @brief Class that facilitates reading a raw audio file.
 | 
			
		||||
   * Files can be read from flash (stored in a AudioFile struct) or from an http source.
 | 
			
		||||
   * The file data is sent to a ring buffer sink.
 | 
			
		||||
   */
 | 
			
		||||
 public:
 | 
			
		||||
  /// @brief Constructs an AudioReader object.
 | 
			
		||||
  /// The transfer buffer isn't allocated here, but only if necessary (an http source) in the start function.
 | 
			
		||||
  /// @param buffer_size Transfer buffer size in bytes.
 | 
			
		||||
  AudioReader(size_t buffer_size) : buffer_size_(buffer_size) {}
 | 
			
		||||
  ~AudioReader();
 | 
			
		||||
 | 
			
		||||
  /// @brief Adds a sink ring buffer for audio data. Takes ownership of the ring buffer in a shared_ptr
 | 
			
		||||
  /// @param output_ring_buffer weak_ptr of a shared_ptr of the sink ring buffer to transfer ownership
 | 
			
		||||
  /// @return  ESP_OK if successful, ESP_ERR_INVALID_STATE otherwise
 | 
			
		||||
  esp_err_t add_sink(const std::weak_ptr<RingBuffer> &output_ring_buffer);
 | 
			
		||||
 | 
			
		||||
  /// @brief Starts reading an audio file from an http source. The transfer buffer is allocated here.
 | 
			
		||||
  /// @param uri Web url to the http file.
 | 
			
		||||
  /// @param file_type AudioFileType variable passed-by-reference indicating the type of file being read.
 | 
			
		||||
  /// @return ESP_OK if successful, an ESP_ERR* code otherwise.
 | 
			
		||||
  esp_err_t start(const std::string &uri, AudioFileType &file_type);
 | 
			
		||||
 | 
			
		||||
  /// @brief Starts reading an audio file from flash. No transfer buffer is allocated.
 | 
			
		||||
  /// @param audio_file AudioFile struct containing the file.
 | 
			
		||||
  /// @param file_type AudioFileType variable passed-by-reference indicating the type of file being read.
 | 
			
		||||
  /// @return ESP_OK
 | 
			
		||||
  esp_err_t start(AudioFile *audio_file, AudioFileType &file_type);
 | 
			
		||||
 | 
			
		||||
  /// @brief Reads new file data from the source and sends to the ring buffer sink.
 | 
			
		||||
  /// @return AudioReaderState
 | 
			
		||||
  AudioReaderState read();
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  /// @brief Monitors the http client events to attempt determining the file type from the Content-Type header
 | 
			
		||||
  static esp_err_t http_event_handler(esp_http_client_event_t *evt);
 | 
			
		||||
 | 
			
		||||
  /// @brief Determines the audio file type from the http header's Content-Type key
 | 
			
		||||
  /// @param content_type string with the Content-Type key
 | 
			
		||||
  /// @return AudioFileType of the url, if it can be determined. If not, return AudioFileType::NONE.
 | 
			
		||||
  static AudioFileType get_audio_type(const char *content_type);
 | 
			
		||||
 | 
			
		||||
  AudioReaderState file_read_();
 | 
			
		||||
  AudioReaderState http_read_();
 | 
			
		||||
 | 
			
		||||
  std::shared_ptr<RingBuffer> file_ring_buffer_;
 | 
			
		||||
  std::unique_ptr<AudioSinkTransferBuffer> output_transfer_buffer_;
 | 
			
		||||
  void cleanup_connection_();
 | 
			
		||||
 | 
			
		||||
  size_t buffer_size_;
 | 
			
		||||
  uint32_t last_data_read_ms_;
 | 
			
		||||
 | 
			
		||||
  esp_http_client_handle_t client_{nullptr};
 | 
			
		||||
 | 
			
		||||
  AudioFile *current_audio_file_{nullptr};
 | 
			
		||||
  AudioFileType audio_file_type_{AudioFileType::NONE};
 | 
			
		||||
  const uint8_t *file_current_{nullptr};
 | 
			
		||||
};
 | 
			
		||||
}  // namespace audio
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
 | 
			
		||||
#endif
 | 
			
		||||
@@ -1,159 +0,0 @@
 | 
			
		||||
#include "audio_resampler.h"
 | 
			
		||||
 | 
			
		||||
#ifdef USE_ESP32
 | 
			
		||||
 | 
			
		||||
#include "esphome/core/hal.h"
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace audio {
 | 
			
		||||
 | 
			
		||||
static const uint32_t READ_WRITE_TIMEOUT_MS = 20;
 | 
			
		||||
 | 
			
		||||
AudioResampler::AudioResampler(size_t input_buffer_size, size_t output_buffer_size)
 | 
			
		||||
    : input_buffer_size_(input_buffer_size), output_buffer_size_(output_buffer_size) {
 | 
			
		||||
  this->input_transfer_buffer_ = AudioSourceTransferBuffer::create(input_buffer_size);
 | 
			
		||||
  this->output_transfer_buffer_ = AudioSinkTransferBuffer::create(output_buffer_size);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
esp_err_t AudioResampler::add_source(std::weak_ptr<RingBuffer> &input_ring_buffer) {
 | 
			
		||||
  if (this->input_transfer_buffer_ != nullptr) {
 | 
			
		||||
    this->input_transfer_buffer_->set_source(input_ring_buffer);
 | 
			
		||||
    return ESP_OK;
 | 
			
		||||
  }
 | 
			
		||||
  return ESP_ERR_NO_MEM;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
esp_err_t AudioResampler::add_sink(std::weak_ptr<RingBuffer> &output_ring_buffer) {
 | 
			
		||||
  if (this->output_transfer_buffer_ != nullptr) {
 | 
			
		||||
    this->output_transfer_buffer_->set_sink(output_ring_buffer);
 | 
			
		||||
    return ESP_OK;
 | 
			
		||||
  }
 | 
			
		||||
  return ESP_ERR_NO_MEM;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
#ifdef USE_SPEAKER
 | 
			
		||||
esp_err_t AudioResampler::add_sink(speaker::Speaker *speaker) {
 | 
			
		||||
  if (this->output_transfer_buffer_ != nullptr) {
 | 
			
		||||
    this->output_transfer_buffer_->set_sink(speaker);
 | 
			
		||||
    return ESP_OK;
 | 
			
		||||
  }
 | 
			
		||||
  return ESP_ERR_NO_MEM;
 | 
			
		||||
}
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
esp_err_t AudioResampler::start(AudioStreamInfo &input_stream_info, AudioStreamInfo &output_stream_info,
 | 
			
		||||
                                uint16_t number_of_taps, uint16_t number_of_filters) {
 | 
			
		||||
  this->input_stream_info_ = input_stream_info;
 | 
			
		||||
  this->output_stream_info_ = output_stream_info;
 | 
			
		||||
 | 
			
		||||
  if ((this->input_transfer_buffer_ == nullptr) || (this->output_transfer_buffer_ == nullptr)) {
 | 
			
		||||
    return ESP_ERR_NO_MEM;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  if ((input_stream_info.get_bits_per_sample() > 32) || (output_stream_info.get_bits_per_sample() > 32) ||
 | 
			
		||||
      (input_stream_info_.get_channels() != output_stream_info.get_channels())) {
 | 
			
		||||
    return ESP_ERR_NOT_SUPPORTED;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  if ((input_stream_info.get_sample_rate() != output_stream_info.get_sample_rate()) ||
 | 
			
		||||
      (input_stream_info.get_bits_per_sample() != output_stream_info.get_bits_per_sample())) {
 | 
			
		||||
    this->resampler_ = make_unique<esp_audio_libs::resampler::Resampler>(
 | 
			
		||||
        input_stream_info.bytes_to_samples(this->input_buffer_size_),
 | 
			
		||||
        output_stream_info.bytes_to_samples(this->output_buffer_size_));
 | 
			
		||||
 | 
			
		||||
    // Use cascaded biquad filters when downsampling to avoid aliasing
 | 
			
		||||
    bool use_pre_filter = output_stream_info.get_sample_rate() < input_stream_info.get_sample_rate();
 | 
			
		||||
 | 
			
		||||
    esp_audio_libs::resampler::ResamplerConfiguration resample_config = {
 | 
			
		||||
        .source_sample_rate = static_cast<float>(input_stream_info.get_sample_rate()),
 | 
			
		||||
        .target_sample_rate = static_cast<float>(output_stream_info.get_sample_rate()),
 | 
			
		||||
        .source_bits_per_sample = input_stream_info.get_bits_per_sample(),
 | 
			
		||||
        .target_bits_per_sample = output_stream_info.get_bits_per_sample(),
 | 
			
		||||
        .channels = input_stream_info_.get_channels(),
 | 
			
		||||
        .use_pre_or_post_filter = use_pre_filter,
 | 
			
		||||
        .subsample_interpolate = false,  // Doubles the CPU load. Using more filters is a better alternative
 | 
			
		||||
        .number_of_taps = number_of_taps,
 | 
			
		||||
        .number_of_filters = number_of_filters,
 | 
			
		||||
    };
 | 
			
		||||
 | 
			
		||||
    if (!this->resampler_->initialize(resample_config)) {
 | 
			
		||||
      // Failed to allocate the resampler's internal buffers
 | 
			
		||||
      return ESP_ERR_NO_MEM;
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  return ESP_OK;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
AudioResamplerState AudioResampler::resample(bool stop_gracefully, int32_t *ms_differential) {
 | 
			
		||||
  if (stop_gracefully) {
 | 
			
		||||
    if (!this->input_transfer_buffer_->has_buffered_data() && (this->output_transfer_buffer_->available() == 0)) {
 | 
			
		||||
      return AudioResamplerState::FINISHED;
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  if (!this->pause_output_) {
 | 
			
		||||
    // Move audio data to the sink
 | 
			
		||||
    this->output_transfer_buffer_->transfer_data_to_sink(pdMS_TO_TICKS(READ_WRITE_TIMEOUT_MS));
 | 
			
		||||
  } else {
 | 
			
		||||
    // If paused, block to avoid wasting CPU resources
 | 
			
		||||
    delay(READ_WRITE_TIMEOUT_MS);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  this->input_transfer_buffer_->transfer_data_from_source(pdMS_TO_TICKS(READ_WRITE_TIMEOUT_MS));
 | 
			
		||||
 | 
			
		||||
  if (this->input_transfer_buffer_->available() == 0) {
 | 
			
		||||
    // No samples available to process
 | 
			
		||||
    return AudioResamplerState::RESAMPLING;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  const size_t bytes_free = this->output_transfer_buffer_->free();
 | 
			
		||||
  const uint32_t frames_free = this->output_stream_info_.bytes_to_frames(bytes_free);
 | 
			
		||||
 | 
			
		||||
  const size_t bytes_available = this->input_transfer_buffer_->available();
 | 
			
		||||
  const uint32_t frames_available = this->input_stream_info_.bytes_to_frames(bytes_available);
 | 
			
		||||
 | 
			
		||||
  if ((this->input_stream_info_.get_sample_rate() != this->output_stream_info_.get_sample_rate()) ||
 | 
			
		||||
      (this->input_stream_info_.get_bits_per_sample() != this->output_stream_info_.get_bits_per_sample())) {
 | 
			
		||||
    esp_audio_libs::resampler::ResamplerResults results =
 | 
			
		||||
        this->resampler_->resample(this->input_transfer_buffer_->get_buffer_start(),
 | 
			
		||||
                                   this->output_transfer_buffer_->get_buffer_end(), frames_available, frames_free, -3);
 | 
			
		||||
 | 
			
		||||
    this->input_transfer_buffer_->decrease_buffer_length(this->input_stream_info_.frames_to_bytes(results.frames_used));
 | 
			
		||||
    this->output_transfer_buffer_->increase_buffer_length(
 | 
			
		||||
        this->output_stream_info_.frames_to_bytes(results.frames_generated));
 | 
			
		||||
 | 
			
		||||
    // Resampling causes slight differences in the durations used versus generated. Computes the difference in
 | 
			
		||||
    // millisconds. The callback function passing the played audio duration uses the difference to convert from output
 | 
			
		||||
    // duration to input duration.
 | 
			
		||||
    this->accumulated_frames_used_ += results.frames_used;
 | 
			
		||||
    this->accumulated_frames_generated_ += results.frames_generated;
 | 
			
		||||
 | 
			
		||||
    const int32_t used_ms =
 | 
			
		||||
        this->input_stream_info_.frames_to_milliseconds_with_remainder(&this->accumulated_frames_used_);
 | 
			
		||||
    const int32_t generated_ms =
 | 
			
		||||
        this->output_stream_info_.frames_to_milliseconds_with_remainder(&this->accumulated_frames_generated_);
 | 
			
		||||
 | 
			
		||||
    *ms_differential = used_ms - generated_ms;
 | 
			
		||||
 | 
			
		||||
  } else {
 | 
			
		||||
    // No resampling required, copy samples directly to the output transfer buffer
 | 
			
		||||
    *ms_differential = 0;
 | 
			
		||||
 | 
			
		||||
    const size_t bytes_to_transfer = std::min(this->output_stream_info_.frames_to_bytes(frames_free),
 | 
			
		||||
                                              this->input_stream_info_.frames_to_bytes(frames_available));
 | 
			
		||||
 | 
			
		||||
    std::memcpy((void *) this->output_transfer_buffer_->get_buffer_end(),
 | 
			
		||||
                (void *) this->input_transfer_buffer_->get_buffer_start(), bytes_to_transfer);
 | 
			
		||||
 | 
			
		||||
    this->input_transfer_buffer_->decrease_buffer_length(bytes_to_transfer);
 | 
			
		||||
    this->output_transfer_buffer_->increase_buffer_length(bytes_to_transfer);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  return AudioResamplerState::RESAMPLING;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
}  // namespace audio
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
 | 
			
		||||
#endif
 | 
			
		||||
@@ -1,101 +0,0 @@
 | 
			
		||||
#pragma once
 | 
			
		||||
 | 
			
		||||
#ifdef USE_ESP32
 | 
			
		||||
 | 
			
		||||
#include "audio.h"
 | 
			
		||||
#include "audio_transfer_buffer.h"
 | 
			
		||||
 | 
			
		||||
#include "esphome/core/defines.h"
 | 
			
		||||
#include "esphome/core/ring_buffer.h"
 | 
			
		||||
 | 
			
		||||
#ifdef USE_SPEAKER
 | 
			
		||||
#include "esphome/components/speaker/speaker.h"
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#include "esp_err.h"
 | 
			
		||||
 | 
			
		||||
#include <resampler.h>  // esp-audio-libs
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace audio {
 | 
			
		||||
 | 
			
		||||
enum class AudioResamplerState : uint8_t {
 | 
			
		||||
  RESAMPLING,  // More data is available to resample
 | 
			
		||||
  FINISHED,    // All file data has been resampled and transferred
 | 
			
		||||
  FAILED,      // Unused state included for consistency among Audio classes
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
class AudioResampler {
 | 
			
		||||
  /*
 | 
			
		||||
   * @brief Class that facilitates resampling audio.
 | 
			
		||||
   * The audio data is read from a ring buffer source, resampled, and sent to an audio sink (ring buffer or speaker
 | 
			
		||||
   * component). Also supports converting bits per sample.
 | 
			
		||||
   */
 | 
			
		||||
 public:
 | 
			
		||||
  /// @brief Allocates the input and output transfer buffers
 | 
			
		||||
  /// @param input_buffer_size Size of the input transfer buffer in bytes.
 | 
			
		||||
  /// @param output_buffer_size Size of the output transfer buffer in bytes.
 | 
			
		||||
  AudioResampler(size_t input_buffer_size, size_t output_buffer_size);
 | 
			
		||||
 | 
			
		||||
  /// @brief Adds a source ring buffer for audio data. Takes ownership of the ring buffer in a shared_ptr.
 | 
			
		||||
  /// @param input_ring_buffer weak_ptr of a shared_ptr of the sink ring buffer to transfer ownership
 | 
			
		||||
  /// @return ESP_OK if successsful, ESP_ERR_NO_MEM if the transfer buffer wasn't allocated
 | 
			
		||||
  esp_err_t add_source(std::weak_ptr<RingBuffer> &input_ring_buffer);
 | 
			
		||||
 | 
			
		||||
  /// @brief Adds a sink ring buffer for resampled audio. Takes ownership of the ring buffer in a shared_ptr.
 | 
			
		||||
  /// @param output_ring_buffer weak_ptr of a shared_ptr of the sink ring buffer to transfer ownership
 | 
			
		||||
  /// @return ESP_OK if successsful, ESP_ERR_NO_MEM if the transfer buffer wasn't allocated
 | 
			
		||||
  esp_err_t add_sink(std::weak_ptr<RingBuffer> &output_ring_buffer);
 | 
			
		||||
 | 
			
		||||
#ifdef USE_SPEAKER
 | 
			
		||||
  /// @brief Adds a sink speaker for decoded audio.
 | 
			
		||||
  /// @param speaker pointer to speaker component
 | 
			
		||||
  /// @return ESP_OK if successsful, ESP_ERR_NO_MEM if the transfer buffer wasn't allocated
 | 
			
		||||
  esp_err_t add_sink(speaker::Speaker *speaker);
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
  /// @brief Sets up the class to resample.
 | 
			
		||||
  /// @param input_stream_info The incoming sample rate, bits per sample, and number of channels
 | 
			
		||||
  /// @param output_stream_info The desired outgoing sample rate, bits per sample, and number of channels
 | 
			
		||||
  /// @param number_of_taps Number of taps per FIR filter
 | 
			
		||||
  /// @param number_of_filters Number of FIR filters
 | 
			
		||||
  /// @return ESP_OK if it is able to convert the incoming stream,
 | 
			
		||||
  ///         ESP_ERR_NO_MEM if the transfer buffers failed to allocate,
 | 
			
		||||
  ///         ESP_ERR_NOT_SUPPORTED if the stream can't be converted.
 | 
			
		||||
  esp_err_t start(AudioStreamInfo &input_stream_info, AudioStreamInfo &output_stream_info, uint16_t number_of_taps,
 | 
			
		||||
                  uint16_t number_of_filters);
 | 
			
		||||
 | 
			
		||||
  /// @brief Resamples audio from the ring buffer source and writes to the sink.
 | 
			
		||||
  /// @param stop_gracefully If true, it indicates the file decoder is finished. The resampler will resample all the
 | 
			
		||||
  ///                        remaining audio and then finish.
 | 
			
		||||
  /// @param ms_differential Pointer to a (int32_t) variable that will store the difference, in milliseconds, between
 | 
			
		||||
  ///                        the duration of input audio used and the duration of output audio generated.
 | 
			
		||||
  /// @return AudioResamplerState
 | 
			
		||||
  AudioResamplerState resample(bool stop_gracefully, int32_t *ms_differential);
 | 
			
		||||
 | 
			
		||||
  /// @brief Pauses sending resampled audio to the sink. If paused, it will continue to process internal buffers.
 | 
			
		||||
  /// @param pause_state If true, audio data is not sent to the sink.
 | 
			
		||||
  void set_pause_output_state(bool pause_state) { this->pause_output_ = pause_state; }
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  std::unique_ptr<AudioSourceTransferBuffer> input_transfer_buffer_;
 | 
			
		||||
  std::unique_ptr<AudioSinkTransferBuffer> output_transfer_buffer_;
 | 
			
		||||
 | 
			
		||||
  size_t input_buffer_size_;
 | 
			
		||||
  size_t output_buffer_size_;
 | 
			
		||||
 | 
			
		||||
  uint32_t accumulated_frames_used_{0};
 | 
			
		||||
  uint32_t accumulated_frames_generated_{0};
 | 
			
		||||
 | 
			
		||||
  bool pause_output_{false};
 | 
			
		||||
 | 
			
		||||
  AudioStreamInfo input_stream_info_;
 | 
			
		||||
  AudioStreamInfo output_stream_info_;
 | 
			
		||||
 | 
			
		||||
  std::unique_ptr<esp_audio_libs::resampler::Resampler> resampler_;
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
}  // namespace audio
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
 | 
			
		||||
#endif
 | 
			
		||||
@@ -1,165 +0,0 @@
 | 
			
		||||
#include "audio_transfer_buffer.h"
 | 
			
		||||
 | 
			
		||||
#ifdef USE_ESP32
 | 
			
		||||
 | 
			
		||||
#include "esphome/core/helpers.h"
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace audio {
 | 
			
		||||
 | 
			
		||||
AudioTransferBuffer::~AudioTransferBuffer() { this->deallocate_buffer_(); };
 | 
			
		||||
 | 
			
		||||
std::unique_ptr<AudioSinkTransferBuffer> AudioSinkTransferBuffer::create(size_t buffer_size) {
 | 
			
		||||
  std::unique_ptr<AudioSinkTransferBuffer> sink_buffer = make_unique<AudioSinkTransferBuffer>();
 | 
			
		||||
 | 
			
		||||
  if (!sink_buffer->allocate_buffer_(buffer_size)) {
 | 
			
		||||
    return nullptr;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  return sink_buffer;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
std::unique_ptr<AudioSourceTransferBuffer> AudioSourceTransferBuffer::create(size_t buffer_size) {
 | 
			
		||||
  std::unique_ptr<AudioSourceTransferBuffer> source_buffer = make_unique<AudioSourceTransferBuffer>();
 | 
			
		||||
 | 
			
		||||
  if (!source_buffer->allocate_buffer_(buffer_size)) {
 | 
			
		||||
    return nullptr;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  return source_buffer;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
size_t AudioTransferBuffer::free() const {
 | 
			
		||||
  if (this->buffer_size_ == 0) {
 | 
			
		||||
    return 0;
 | 
			
		||||
  }
 | 
			
		||||
  return this->buffer_size_ - (this->buffer_length_ - (this->data_start_ - this->buffer_));
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void AudioTransferBuffer::decrease_buffer_length(size_t bytes) {
 | 
			
		||||
  this->buffer_length_ -= bytes;
 | 
			
		||||
  this->data_start_ += bytes;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void AudioTransferBuffer::increase_buffer_length(size_t bytes) { this->buffer_length_ += bytes; }
 | 
			
		||||
 | 
			
		||||
void AudioTransferBuffer::clear_buffered_data() {
 | 
			
		||||
  this->buffer_length_ = 0;
 | 
			
		||||
  if (this->ring_buffer_.use_count() > 0) {
 | 
			
		||||
    this->ring_buffer_->reset();
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void AudioSinkTransferBuffer::clear_buffered_data() {
 | 
			
		||||
  this->buffer_length_ = 0;
 | 
			
		||||
  if (this->ring_buffer_.use_count() > 0) {
 | 
			
		||||
    this->ring_buffer_->reset();
 | 
			
		||||
  }
 | 
			
		||||
#ifdef USE_SPEAKER
 | 
			
		||||
  if (this->speaker_ != nullptr) {
 | 
			
		||||
    this->speaker_->stop();
 | 
			
		||||
  }
 | 
			
		||||
#endif
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
bool AudioTransferBuffer::has_buffered_data() const {
 | 
			
		||||
  if (this->ring_buffer_.use_count() > 0) {
 | 
			
		||||
    return ((this->ring_buffer_->available() > 0) || (this->available() > 0));
 | 
			
		||||
  }
 | 
			
		||||
  return (this->available() > 0);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
bool AudioTransferBuffer::reallocate(size_t new_buffer_size) {
 | 
			
		||||
  if (this->buffer_length_ > 0) {
 | 
			
		||||
    // Already has data in the buffer, fail
 | 
			
		||||
    return false;
 | 
			
		||||
  }
 | 
			
		||||
  this->deallocate_buffer_();
 | 
			
		||||
  return this->allocate_buffer_(new_buffer_size);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
bool AudioTransferBuffer::allocate_buffer_(size_t buffer_size) {
 | 
			
		||||
  this->buffer_size_ = buffer_size;
 | 
			
		||||
 | 
			
		||||
  RAMAllocator<uint8_t> allocator(ExternalRAMAllocator<uint8_t>::ALLOW_FAILURE);
 | 
			
		||||
 | 
			
		||||
  this->buffer_ = allocator.allocate(this->buffer_size_);
 | 
			
		||||
  if (this->buffer_ == nullptr) {
 | 
			
		||||
    return false;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  this->data_start_ = this->buffer_;
 | 
			
		||||
  this->buffer_length_ = 0;
 | 
			
		||||
 | 
			
		||||
  return true;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void AudioTransferBuffer::deallocate_buffer_() {
 | 
			
		||||
  if (this->buffer_ != nullptr) {
 | 
			
		||||
    RAMAllocator<uint8_t> allocator(ExternalRAMAllocator<uint8_t>::ALLOW_FAILURE);
 | 
			
		||||
    allocator.deallocate(this->buffer_, this->buffer_size_);
 | 
			
		||||
    this->buffer_ = nullptr;
 | 
			
		||||
    this->data_start_ = nullptr;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  this->buffer_size_ = 0;
 | 
			
		||||
  this->buffer_length_ = 0;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
size_t AudioSourceTransferBuffer::transfer_data_from_source(TickType_t ticks_to_wait) {
 | 
			
		||||
  // Shift data in buffer to start
 | 
			
		||||
  if (this->buffer_length_ > 0) {
 | 
			
		||||
    memmove(this->buffer_, this->data_start_, this->buffer_length_);
 | 
			
		||||
  }
 | 
			
		||||
  this->data_start_ = this->buffer_;
 | 
			
		||||
 | 
			
		||||
  size_t bytes_to_read = this->free();
 | 
			
		||||
  size_t bytes_read = 0;
 | 
			
		||||
  if (bytes_to_read > 0) {
 | 
			
		||||
    if (this->ring_buffer_.use_count() > 0) {
 | 
			
		||||
      bytes_read = this->ring_buffer_->read((void *) this->get_buffer_end(), bytes_to_read, ticks_to_wait);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    this->increase_buffer_length(bytes_read);
 | 
			
		||||
  }
 | 
			
		||||
  return bytes_read;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
size_t AudioSinkTransferBuffer::transfer_data_to_sink(TickType_t ticks_to_wait) {
 | 
			
		||||
  size_t bytes_written = 0;
 | 
			
		||||
  if (this->available()) {
 | 
			
		||||
#ifdef USE_SPEAKER
 | 
			
		||||
    if (this->speaker_ != nullptr) {
 | 
			
		||||
      bytes_written = this->speaker_->play(this->data_start_, this->available(), ticks_to_wait);
 | 
			
		||||
    } else
 | 
			
		||||
#endif
 | 
			
		||||
        if (this->ring_buffer_.use_count() > 0) {
 | 
			
		||||
      bytes_written =
 | 
			
		||||
          this->ring_buffer_->write_without_replacement((void *) this->data_start_, this->available(), ticks_to_wait);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    this->decrease_buffer_length(bytes_written);
 | 
			
		||||
 | 
			
		||||
    // Shift unwritten data to the start of the buffer
 | 
			
		||||
    memmove(this->buffer_, this->data_start_, this->buffer_length_);
 | 
			
		||||
    this->data_start_ = this->buffer_;
 | 
			
		||||
  }
 | 
			
		||||
  return bytes_written;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
bool AudioSinkTransferBuffer::has_buffered_data() const {
 | 
			
		||||
#ifdef USE_SPEAKER
 | 
			
		||||
  if (this->speaker_ != nullptr) {
 | 
			
		||||
    return (this->speaker_->has_buffered_data() || (this->available() > 0));
 | 
			
		||||
  }
 | 
			
		||||
#endif
 | 
			
		||||
  if (this->ring_buffer_.use_count() > 0) {
 | 
			
		||||
    return ((this->ring_buffer_->available() > 0) || (this->available() > 0));
 | 
			
		||||
  }
 | 
			
		||||
  return (this->available() > 0);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
}  // namespace audio
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
 | 
			
		||||
#endif
 | 
			
		||||
@@ -1,139 +0,0 @@
 | 
			
		||||
#pragma once
 | 
			
		||||
 | 
			
		||||
#ifdef USE_ESP32
 | 
			
		||||
#include "esphome/core/defines.h"
 | 
			
		||||
#include "esphome/core/ring_buffer.h"
 | 
			
		||||
 | 
			
		||||
#ifdef USE_SPEAKER
 | 
			
		||||
#include "esphome/components/speaker/speaker.h"
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#include "esp_err.h"
 | 
			
		||||
 | 
			
		||||
#include <freertos/FreeRTOS.h>
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace audio {
 | 
			
		||||
 | 
			
		||||
class AudioTransferBuffer {
 | 
			
		||||
  /*
 | 
			
		||||
   * @brief Class that facilitates tranferring data between a buffer and an audio source or sink.
 | 
			
		||||
   * The transfer buffer is a typical C array that temporarily holds data for processing in other audio components.
 | 
			
		||||
   * Both sink and source transfer buffers can use a ring buffer as the sink/source.
 | 
			
		||||
   *   - The ring buffer is stored in a shared_ptr, so destroying the transfer buffer object will release ownership.
 | 
			
		||||
   */
 | 
			
		||||
 public:
 | 
			
		||||
  /// @brief Destructor that deallocates the transfer buffer
 | 
			
		||||
  ~AudioTransferBuffer();
 | 
			
		||||
 | 
			
		||||
  /// @brief Returns a pointer to the start of the transfer buffer where available() bytes of exisiting data can be read
 | 
			
		||||
  uint8_t *get_buffer_start() const { return this->data_start_; }
 | 
			
		||||
 | 
			
		||||
  /// @brief Returns a pointer to the end of the transfer buffer where free() bytes of new data can be written
 | 
			
		||||
  uint8_t *get_buffer_end() const { return this->data_start_ + this->buffer_length_; }
 | 
			
		||||
 | 
			
		||||
  /// @brief Updates the internal state of the transfer buffer. This should be called after reading data
 | 
			
		||||
  /// @param bytes The number of bytes consumed/read
 | 
			
		||||
  void decrease_buffer_length(size_t bytes);
 | 
			
		||||
 | 
			
		||||
  /// @brief Updates the internal state of the transfer buffer. This should be called after writing data
 | 
			
		||||
  /// @param bytes The number of bytes written
 | 
			
		||||
  void increase_buffer_length(size_t bytes);
 | 
			
		||||
 | 
			
		||||
  /// @brief Returns the transfer buffer's currently available bytes to read
 | 
			
		||||
  size_t available() const { return this->buffer_length_; }
 | 
			
		||||
 | 
			
		||||
  /// @brief Returns the transfer buffers allocated bytes
 | 
			
		||||
  size_t capacity() const { return this->buffer_size_; }
 | 
			
		||||
 | 
			
		||||
  /// @brief Returns the transfer buffer's currrently free bytes available to write
 | 
			
		||||
  size_t free() const;
 | 
			
		||||
 | 
			
		||||
  /// @brief Clears data in the transfer buffer and, if possible, the source/sink.
 | 
			
		||||
  virtual void clear_buffered_data();
 | 
			
		||||
 | 
			
		||||
  /// @brief Tests if there is any data in the tranfer buffer or the source/sink.
 | 
			
		||||
  /// @return True if there is data, false otherwise.
 | 
			
		||||
  virtual bool has_buffered_data() const;
 | 
			
		||||
 | 
			
		||||
  bool reallocate(size_t new_buffer_size);
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  /// @brief Allocates the transfer buffer in external memory, if available.
 | 
			
		||||
  /// @return True is successful, false otherwise.
 | 
			
		||||
  bool allocate_buffer_(size_t buffer_size);
 | 
			
		||||
 | 
			
		||||
  /// @brief Deallocates the buffer and resets the class variables.
 | 
			
		||||
  void deallocate_buffer_();
 | 
			
		||||
 | 
			
		||||
  // A possible source or sink for the transfer buffer
 | 
			
		||||
  std::shared_ptr<RingBuffer> ring_buffer_;
 | 
			
		||||
 | 
			
		||||
  uint8_t *buffer_{nullptr};
 | 
			
		||||
  uint8_t *data_start_{nullptr};
 | 
			
		||||
 | 
			
		||||
  size_t buffer_size_{0};
 | 
			
		||||
  size_t buffer_length_{0};
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
class AudioSinkTransferBuffer : public AudioTransferBuffer {
 | 
			
		||||
  /*
 | 
			
		||||
   * @brief A class that implements a transfer buffer for audio sinks.
 | 
			
		||||
   * Supports writing processed data in the transfer buffer to a ring buffer or a speaker component.
 | 
			
		||||
   */
 | 
			
		||||
 public:
 | 
			
		||||
  /// @brief Creates a new sink transfer buffer.
 | 
			
		||||
  /// @param buffer_size Size of the transfer buffer in bytes.
 | 
			
		||||
  /// @return unique_ptr if successfully allocated, nullptr otherwise
 | 
			
		||||
  static std::unique_ptr<AudioSinkTransferBuffer> create(size_t buffer_size);
 | 
			
		||||
 | 
			
		||||
  /// @brief Writes any available data in the transfer buffer to the sink.
 | 
			
		||||
  /// @param ticks_to_wait FreeRTOS ticks to block while waiting for the sink to have enough space
 | 
			
		||||
  /// @return Number of bytes written
 | 
			
		||||
  size_t transfer_data_to_sink(TickType_t ticks_to_wait);
 | 
			
		||||
 | 
			
		||||
  /// @brief Adds a ring buffer as the transfer buffer's sink.
 | 
			
		||||
  /// @param ring_buffer weak_ptr to the allocated ring buffer
 | 
			
		||||
  void set_sink(const std::weak_ptr<RingBuffer> &ring_buffer) { this->ring_buffer_ = ring_buffer.lock(); }
 | 
			
		||||
 | 
			
		||||
#ifdef USE_SPEAKER
 | 
			
		||||
  /// @brief Adds a speaker as the transfer buffer's sink.
 | 
			
		||||
  /// @param speaker Pointer to the speaker component
 | 
			
		||||
  void set_sink(speaker::Speaker *speaker) { this->speaker_ = speaker; }
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
  void clear_buffered_data() override;
 | 
			
		||||
 | 
			
		||||
  bool has_buffered_data() const override;
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
#ifdef USE_SPEAKER
 | 
			
		||||
  speaker::Speaker *speaker_{nullptr};
 | 
			
		||||
#endif
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
class AudioSourceTransferBuffer : public AudioTransferBuffer {
 | 
			
		||||
  /*
 | 
			
		||||
   * @brief A class that implements a transfer buffer for audio sources.
 | 
			
		||||
   * Supports reading audio data from a ring buffer into the transfer buffer for processing.
 | 
			
		||||
   */
 | 
			
		||||
 public:
 | 
			
		||||
  /// @brief Creates a new source transfer buffer.
 | 
			
		||||
  /// @param buffer_size Size of the transfer buffer in bytes.
 | 
			
		||||
  /// @return unique_ptr if successfully allocated, nullptr otherwise
 | 
			
		||||
  static std::unique_ptr<AudioSourceTransferBuffer> create(size_t buffer_size);
 | 
			
		||||
 | 
			
		||||
  /// @brief Reads any available data from the sink into the transfer buffer.
 | 
			
		||||
  /// @param ticks_to_wait FreeRTOS ticks to block while waiting for the source to have enough data
 | 
			
		||||
  /// @return Number of bytes read
 | 
			
		||||
  size_t transfer_data_from_source(TickType_t ticks_to_wait);
 | 
			
		||||
 | 
			
		||||
  /// @brief Adds a ring buffer as the transfer buffer's source.
 | 
			
		||||
  /// @param ring_buffer weak_ptr to the allocated ring buffer
 | 
			
		||||
  void set_source(const std::weak_ptr<RingBuffer> &ring_buffer) { this->ring_buffer_ = ring_buffer.lock(); };
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
}  // namespace audio
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
 | 
			
		||||
#endif
 | 
			
		||||
@@ -1,41 +0,0 @@
 | 
			
		||||
from esphome import automation
 | 
			
		||||
import esphome.codegen as cg
 | 
			
		||||
import esphome.config_validation as cv
 | 
			
		||||
from esphome.const import CONF_ID, CONF_MIC_GAIN
 | 
			
		||||
from esphome.core import coroutine_with_priority
 | 
			
		||||
 | 
			
		||||
CODEOWNERS = ["@kbx81"]
 | 
			
		||||
IS_PLATFORM_COMPONENT = True
 | 
			
		||||
 | 
			
		||||
audio_adc_ns = cg.esphome_ns.namespace("audio_adc")
 | 
			
		||||
AudioAdc = audio_adc_ns.class_("AudioAdc")
 | 
			
		||||
 | 
			
		||||
SetMicGainAction = audio_adc_ns.class_("SetMicGainAction", automation.Action)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
SET_MIC_GAIN_ACTION_SCHEMA = cv.maybe_simple_value(
 | 
			
		||||
    {
 | 
			
		||||
        cv.GenerateID(): cv.use_id(AudioAdc),
 | 
			
		||||
        cv.Required(CONF_MIC_GAIN): cv.templatable(cv.decibel),
 | 
			
		||||
    },
 | 
			
		||||
    key=CONF_MIC_GAIN,
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
@automation.register_action(
 | 
			
		||||
    "audio_adc.set_mic_gain", SetMicGainAction, SET_MIC_GAIN_ACTION_SCHEMA
 | 
			
		||||
)
 | 
			
		||||
async def audio_adc_set_mic_gain_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_MIC_GAIN), args, float)
 | 
			
		||||
    cg.add(var.set_mic_gain(template_))
 | 
			
		||||
 | 
			
		||||
    return var
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
@coroutine_with_priority(100.0)
 | 
			
		||||
async def to_code(config):
 | 
			
		||||
    cg.add_define("USE_AUDIO_ADC")
 | 
			
		||||
    cg.add_global(audio_adc_ns.using)
 | 
			
		||||
@@ -1,17 +0,0 @@
 | 
			
		||||
#pragma once
 | 
			
		||||
 | 
			
		||||
#include "esphome/core/defines.h"
 | 
			
		||||
#include "esphome/core/hal.h"
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace audio_adc {
 | 
			
		||||
 | 
			
		||||
class AudioAdc {
 | 
			
		||||
 public:
 | 
			
		||||
  virtual bool set_mic_gain(float mic_gain) = 0;
 | 
			
		||||
 | 
			
		||||
  virtual float mic_gain() = 0;
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
}  // namespace audio_adc
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
@@ -1,23 +0,0 @@
 | 
			
		||||
#pragma once
 | 
			
		||||
 | 
			
		||||
#include "esphome/core/automation.h"
 | 
			
		||||
#include "esphome/core/component.h"
 | 
			
		||||
#include "audio_adc.h"
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace audio_adc {
 | 
			
		||||
 | 
			
		||||
template<typename... Ts> class SetMicGainAction : public Action<Ts...> {
 | 
			
		||||
 public:
 | 
			
		||||
  explicit SetMicGainAction(AudioAdc *audio_adc) : audio_adc_(audio_adc) {}
 | 
			
		||||
 | 
			
		||||
  TEMPLATABLE_VALUE(float, mic_gain)
 | 
			
		||||
 | 
			
		||||
  void play(Ts... x) override { this->audio_adc_->set_mic_gain(this->mic_gain_.value(x...)); }
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  AudioAdc *audio_adc_;
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
}  // namespace audio_adc
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
@@ -1,57 +0,0 @@
 | 
			
		||||
from esphome import automation
 | 
			
		||||
from esphome.automation import maybe_simple_id
 | 
			
		||||
import esphome.codegen as cg
 | 
			
		||||
import esphome.config_validation as cv
 | 
			
		||||
from esphome.const import CONF_ID, CONF_VOLUME
 | 
			
		||||
from esphome.core import coroutine_with_priority
 | 
			
		||||
 | 
			
		||||
CODEOWNERS = ["@kbx81"]
 | 
			
		||||
IS_PLATFORM_COMPONENT = True
 | 
			
		||||
 | 
			
		||||
audio_dac_ns = cg.esphome_ns.namespace("audio_dac")
 | 
			
		||||
AudioDac = audio_dac_ns.class_("AudioDac")
 | 
			
		||||
 | 
			
		||||
MuteOffAction = audio_dac_ns.class_("MuteOffAction", automation.Action)
 | 
			
		||||
MuteOnAction = audio_dac_ns.class_("MuteOnAction", automation.Action)
 | 
			
		||||
SetVolumeAction = audio_dac_ns.class_("SetVolumeAction", automation.Action)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
MUTE_ACTION_SCHEMA = maybe_simple_id(
 | 
			
		||||
    {
 | 
			
		||||
        cv.GenerateID(): cv.use_id(AudioDac),
 | 
			
		||||
    }
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
SET_VOLUME_ACTION_SCHEMA = cv.maybe_simple_value(
 | 
			
		||||
    {
 | 
			
		||||
        cv.GenerateID(): cv.use_id(AudioDac),
 | 
			
		||||
        cv.Required(CONF_VOLUME): cv.templatable(cv.percentage),
 | 
			
		||||
    },
 | 
			
		||||
    key=CONF_VOLUME,
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
@automation.register_action("audio_dac.mute_off", MuteOffAction, MUTE_ACTION_SCHEMA)
 | 
			
		||||
@automation.register_action("audio_dac.mute_on", MuteOnAction, MUTE_ACTION_SCHEMA)
 | 
			
		||||
async def audio_dac_mute_action_to_code(config, action_id, template_arg, args):
 | 
			
		||||
    paren = await cg.get_variable(config[CONF_ID])
 | 
			
		||||
    return cg.new_Pvariable(action_id, template_arg, paren)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
@automation.register_action(
 | 
			
		||||
    "audio_dac.set_volume", SetVolumeAction, SET_VOLUME_ACTION_SCHEMA
 | 
			
		||||
)
 | 
			
		||||
async def audio_dac_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_VOLUME), args, float)
 | 
			
		||||
    cg.add(var.set_volume(template_))
 | 
			
		||||
 | 
			
		||||
    return var
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
@coroutine_with_priority(100.0)
 | 
			
		||||
async def to_code(config):
 | 
			
		||||
    cg.add_define("USE_AUDIO_DAC")
 | 
			
		||||
    cg.add_global(audio_dac_ns.using)
 | 
			
		||||
@@ -1,23 +0,0 @@
 | 
			
		||||
#pragma once
 | 
			
		||||
 | 
			
		||||
#include "esphome/core/defines.h"
 | 
			
		||||
#include "esphome/core/hal.h"
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace audio_dac {
 | 
			
		||||
 | 
			
		||||
class AudioDac {
 | 
			
		||||
 public:
 | 
			
		||||
  virtual bool set_mute_off() = 0;
 | 
			
		||||
  virtual bool set_mute_on() = 0;
 | 
			
		||||
  virtual bool set_volume(float volume) = 0;
 | 
			
		||||
 | 
			
		||||
  virtual bool is_muted() = 0;
 | 
			
		||||
  virtual float volume() = 0;
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  bool is_muted_{false};
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
}  // namespace audio_dac
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
@@ -1,43 +0,0 @@
 | 
			
		||||
#pragma once
 | 
			
		||||
 | 
			
		||||
#include "esphome/core/automation.h"
 | 
			
		||||
#include "esphome/core/component.h"
 | 
			
		||||
#include "audio_dac.h"
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace audio_dac {
 | 
			
		||||
 | 
			
		||||
template<typename... Ts> class MuteOffAction : public Action<Ts...> {
 | 
			
		||||
 public:
 | 
			
		||||
  explicit MuteOffAction(AudioDac *audio_dac) : audio_dac_(audio_dac) {}
 | 
			
		||||
 | 
			
		||||
  void play(Ts... x) override { this->audio_dac_->set_mute_off(); }
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  AudioDac *audio_dac_;
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
template<typename... Ts> class MuteOnAction : public Action<Ts...> {
 | 
			
		||||
 public:
 | 
			
		||||
  explicit MuteOnAction(AudioDac *audio_dac) : audio_dac_(audio_dac) {}
 | 
			
		||||
 | 
			
		||||
  void play(Ts... x) override { this->audio_dac_->set_mute_on(); }
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  AudioDac *audio_dac_;
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
template<typename... Ts> class SetVolumeAction : public Action<Ts...> {
 | 
			
		||||
 public:
 | 
			
		||||
  explicit SetVolumeAction(AudioDac *audio_dac) : audio_dac_(audio_dac) {}
 | 
			
		||||
 | 
			
		||||
  TEMPLATABLE_VALUE(float, volume)
 | 
			
		||||
 | 
			
		||||
  void play(Ts... x) override { this->audio_dac_->set_volume(this->volume_.value(x...)); }
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  AudioDac *audio_dac_;
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
}  // namespace audio_dac
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
@@ -1,6 +0,0 @@
 | 
			
		||||
import esphome.codegen as cg
 | 
			
		||||
 | 
			
		||||
CODEOWNERS = ["@clydebarrow"]
 | 
			
		||||
DEPENDENCIES = ["i2c"]
 | 
			
		||||
 | 
			
		||||
axs15231_ns = cg.esphome_ns.namespace("axs15231")
 | 
			
		||||
@@ -1,36 +0,0 @@
 | 
			
		||||
from esphome import pins
 | 
			
		||||
import esphome.codegen as cg
 | 
			
		||||
from esphome.components import i2c, touchscreen
 | 
			
		||||
import esphome.config_validation as cv
 | 
			
		||||
from esphome.const import CONF_ID, CONF_INTERRUPT_PIN, CONF_RESET_PIN
 | 
			
		||||
 | 
			
		||||
from .. import axs15231_ns
 | 
			
		||||
 | 
			
		||||
AXS15231Touchscreen = axs15231_ns.class_(
 | 
			
		||||
    "AXS15231Touchscreen",
 | 
			
		||||
    touchscreen.Touchscreen,
 | 
			
		||||
    i2c.I2CDevice,
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
CONFIG_SCHEMA = (
 | 
			
		||||
    touchscreen.touchscreen_schema("50ms")
 | 
			
		||||
    .extend(
 | 
			
		||||
        {
 | 
			
		||||
            cv.GenerateID(): cv.declare_id(AXS15231Touchscreen),
 | 
			
		||||
            cv.Optional(CONF_INTERRUPT_PIN): pins.internal_gpio_input_pin_schema,
 | 
			
		||||
            cv.Optional(CONF_RESET_PIN): pins.gpio_output_pin_schema,
 | 
			
		||||
        }
 | 
			
		||||
    )
 | 
			
		||||
    .extend(i2c.i2c_device_schema(0x3B))
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
async def to_code(config):
 | 
			
		||||
    var = cg.new_Pvariable(config[CONF_ID])
 | 
			
		||||
    await touchscreen.register_touchscreen(var, config)
 | 
			
		||||
    await i2c.register_i2c_device(var, config)
 | 
			
		||||
 | 
			
		||||
    if interrupt_pin := config.get(CONF_INTERRUPT_PIN):
 | 
			
		||||
        cg.add(var.set_interrupt_pin(await cg.gpio_pin_expression(interrupt_pin)))
 | 
			
		||||
    if reset_pin := config.get(CONF_RESET_PIN):
 | 
			
		||||
        cg.add(var.set_reset_pin(await cg.gpio_pin_expression(reset_pin)))
 | 
			
		||||
@@ -1,64 +0,0 @@
 | 
			
		||||
#include "axs15231_touchscreen.h"
 | 
			
		||||
 | 
			
		||||
#include "esphome/core/helpers.h"
 | 
			
		||||
#include "esphome/core/log.h"
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace axs15231 {
 | 
			
		||||
 | 
			
		||||
static const char *const TAG = "ax15231.touchscreen";
 | 
			
		||||
 | 
			
		||||
constexpr static const uint8_t AXS_READ_TOUCHPAD[11] = {0xb5, 0xab, 0xa5, 0x5a, 0x0, 0x0, 0x0, 0x8};
 | 
			
		||||
 | 
			
		||||
#define ERROR_CHECK(err) \
 | 
			
		||||
  if ((err) != i2c::ERROR_OK) { \
 | 
			
		||||
    this->status_set_warning("Failed to communicate"); \
 | 
			
		||||
    return; \
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
void AXS15231Touchscreen::setup() {
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "Setting up AXS15231 Touchscreen...");
 | 
			
		||||
  if (this->reset_pin_ != nullptr) {
 | 
			
		||||
    this->reset_pin_->setup();
 | 
			
		||||
    this->reset_pin_->digital_write(false);
 | 
			
		||||
    delay(5);
 | 
			
		||||
    this->reset_pin_->digital_write(true);
 | 
			
		||||
    delay(10);
 | 
			
		||||
  }
 | 
			
		||||
  if (this->interrupt_pin_ != nullptr) {
 | 
			
		||||
    this->interrupt_pin_->pin_mode(gpio::FLAG_INPUT);
 | 
			
		||||
    this->interrupt_pin_->setup();
 | 
			
		||||
    this->attach_interrupt_(this->interrupt_pin_, gpio::INTERRUPT_FALLING_EDGE);
 | 
			
		||||
  }
 | 
			
		||||
  this->x_raw_max_ = this->display_->get_native_width();
 | 
			
		||||
  this->y_raw_max_ = this->display_->get_native_height();
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "AXS15231 Touchscreen setup complete");
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void AXS15231Touchscreen::update_touches() {
 | 
			
		||||
  i2c::ErrorCode err;
 | 
			
		||||
  uint8_t data[8]{};
 | 
			
		||||
 | 
			
		||||
  err = this->write(AXS_READ_TOUCHPAD, sizeof(AXS_READ_TOUCHPAD), false);
 | 
			
		||||
  ERROR_CHECK(err);
 | 
			
		||||
  err = this->read(data, sizeof(data));
 | 
			
		||||
  ERROR_CHECK(err);
 | 
			
		||||
  this->status_clear_warning();
 | 
			
		||||
  if (data[0] != 0)  // no touches
 | 
			
		||||
    return;
 | 
			
		||||
  uint16_t x = encode_uint16(data[2] & 0xF, data[3]);
 | 
			
		||||
  uint16_t y = encode_uint16(data[4] & 0xF, data[5]);
 | 
			
		||||
  this->add_raw_touch_position_(0, x, y);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void AXS15231Touchscreen::dump_config() {
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "AXS15231 Touchscreen:");
 | 
			
		||||
  LOG_I2C_DEVICE(this);
 | 
			
		||||
  LOG_PIN("  Interrupt Pin: ", this->interrupt_pin_);
 | 
			
		||||
  LOG_PIN("  Reset Pin: ", this->reset_pin_);
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "  Width: %d", this->x_raw_max_);
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "  Height: %d", this->y_raw_max_);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
}  // namespace axs15231
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
@@ -1,27 +0,0 @@
 | 
			
		||||
#pragma once
 | 
			
		||||
 | 
			
		||||
#include "esphome/components/i2c/i2c.h"
 | 
			
		||||
#include "esphome/components/touchscreen/touchscreen.h"
 | 
			
		||||
#include "esphome/core/component.h"
 | 
			
		||||
#include "esphome/core/hal.h"
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace axs15231 {
 | 
			
		||||
 | 
			
		||||
class AXS15231Touchscreen : public touchscreen::Touchscreen, public i2c::I2CDevice {
 | 
			
		||||
 public:
 | 
			
		||||
  void setup() override;
 | 
			
		||||
  void dump_config() override;
 | 
			
		||||
 | 
			
		||||
  void set_interrupt_pin(InternalGPIOPin *pin) { this->interrupt_pin_ = pin; }
 | 
			
		||||
  void set_reset_pin(GPIOPin *pin) { this->reset_pin_ = pin; }
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  void update_touches() override;
 | 
			
		||||
 | 
			
		||||
  InternalGPIOPin *interrupt_pin_{};
 | 
			
		||||
  GPIOPin *reset_pin_{};
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
}  // namespace axs15231
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
@@ -157,11 +157,8 @@ void BangBangClimate::switch_to_action_(climate::ClimateAction action) {
 | 
			
		||||
    default:
 | 
			
		||||
      trig = nullptr;
 | 
			
		||||
  }
 | 
			
		||||
  if (trig != nullptr) {
 | 
			
		||||
    trig->trigger();
 | 
			
		||||
  } else {
 | 
			
		||||
    ESP_LOGW(TAG, "trig not set - unsupported action");
 | 
			
		||||
  }
 | 
			
		||||
  assert(trig != nullptr);
 | 
			
		||||
  trig->trigger();
 | 
			
		||||
  this->action = action;
 | 
			
		||||
  this->prev_trigger_ = trig;
 | 
			
		||||
  this->publish_state();
 | 
			
		||||
 
 | 
			
		||||
@@ -13,10 +13,8 @@ float bedjet_temp_to_f(const uint8_t temp) {
 | 
			
		||||
 | 
			
		||||
/** Cleans up the packet before sending. */
 | 
			
		||||
BedjetPacket *BedjetCodec::clean_packet_() {
 | 
			
		||||
  // So far no commands require more than 2 bytes of data
 | 
			
		||||
  if (this->packet_.data_length > 2) {
 | 
			
		||||
    ESP_LOGW(TAG, "Packet may be malformed");
 | 
			
		||||
  }
 | 
			
		||||
  // So far no commands require more than 2 bytes of data.
 | 
			
		||||
  assert(this->packet_.data_length <= 2);
 | 
			
		||||
  for (int i = this->packet_.data_length; i < 2; i++) {
 | 
			
		||||
    this->packet_.data[i] = '\0';
 | 
			
		||||
  }
 | 
			
		||||
 
 | 
			
		||||
@@ -25,7 +25,7 @@ from esphome.const import (
 | 
			
		||||
    CONF_STATE,
 | 
			
		||||
    CONF_TIMING,
 | 
			
		||||
    CONF_TRIGGER_ID,
 | 
			
		||||
    CONF_WEB_SERVER,
 | 
			
		||||
    CONF_WEB_SERVER_ID,
 | 
			
		||||
    DEVICE_CLASS_BATTERY,
 | 
			
		||||
    DEVICE_CLASS_BATTERY_CHARGING,
 | 
			
		||||
    DEVICE_CLASS_CARBON_MONOXIDE,
 | 
			
		||||
@@ -543,8 +543,9 @@ async def setup_binary_sensor_core_(var, config):
 | 
			
		||||
        mqtt_ = cg.new_Pvariable(mqtt_id, var)
 | 
			
		||||
        await mqtt.register_mqtt_component(mqtt_, config)
 | 
			
		||||
 | 
			
		||||
    if web_server_config := config.get(CONF_WEB_SERVER):
 | 
			
		||||
        await web_server.add_entity_config(var, web_server_config)
 | 
			
		||||
    if (webserver_id := config.get(CONF_WEB_SERVER_ID)) is not None:
 | 
			
		||||
        web_server_ = await cg.get_variable(webserver_id)
 | 
			
		||||
        web_server.add_entity_to_sorting_list(web_server_, var, config)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
async def register_binary_sensor(var, config):
 | 
			
		||||
 
 | 
			
		||||
@@ -58,7 +58,7 @@ class BinarySensor : public EntityBase, public EntityBase_DeviceClass {
 | 
			
		||||
  void publish_initial_state(bool state);
 | 
			
		||||
 | 
			
		||||
  /// The current reported state of the binary sensor.
 | 
			
		||||
  bool state{false};
 | 
			
		||||
  bool state;
 | 
			
		||||
 | 
			
		||||
  void add_filter(Filter *filter);
 | 
			
		||||
  void add_filters(const std::vector<Filter *> &filters);
 | 
			
		||||
 
 | 
			
		||||
@@ -15,11 +15,10 @@ from esphome.components.libretiny.const import (
 | 
			
		||||
)
 | 
			
		||||
from esphome.core import CORE
 | 
			
		||||
 | 
			
		||||
from .boards import BK72XX_BOARD_PINS, BK72XX_BOARDS
 | 
			
		||||
from .boards import BK72XX_BOARDS, BK72XX_BOARD_PINS
 | 
			
		||||
 | 
			
		||||
CODEOWNERS = ["@kuba2k2"]
 | 
			
		||||
AUTO_LOAD = ["libretiny"]
 | 
			
		||||
IS_TARGET_PLATFORM = True
 | 
			
		||||
 | 
			
		||||
COMPONENT_DATA = LibreTinyComponent(
 | 
			
		||||
    name=COMPONENT_BK72XX,
 | 
			
		||||
 
 | 
			
		||||
@@ -1 +0,0 @@
 | 
			
		||||
CODEOWNERS = ["@athom-tech", "@tarontop", "@jesserockz"]
 | 
			
		||||
@@ -1,238 +0,0 @@
 | 
			
		||||
#include "bl0906.h"
 | 
			
		||||
#include "constants.h"
 | 
			
		||||
 | 
			
		||||
#include "esphome/core/log.h"
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace bl0906 {
 | 
			
		||||
 | 
			
		||||
static const char *const TAG = "bl0906";
 | 
			
		||||
 | 
			
		||||
constexpr uint32_t to_uint32_t(ube24_t input) { return input.h << 16 | input.m << 8 | input.l; }
 | 
			
		||||
 | 
			
		||||
constexpr int32_t to_int32_t(sbe24_t input) { return input.h << 16 | input.m << 8 | input.l; }
 | 
			
		||||
 | 
			
		||||
// The SUM byte is (Addr+Data_L+Data_M+Data_H)&0xFF negated;
 | 
			
		||||
constexpr uint8_t bl0906_checksum(const uint8_t address, const DataPacket *data) {
 | 
			
		||||
  return (address + data->l + data->m + data->h) ^ 0xFF;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void BL0906::loop() {
 | 
			
		||||
  if (this->current_channel_ == UINT8_MAX) {
 | 
			
		||||
    return;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  while (this->available())
 | 
			
		||||
    this->flush();
 | 
			
		||||
 | 
			
		||||
  if (this->current_channel_ == 0) {
 | 
			
		||||
    // Temperature
 | 
			
		||||
    this->read_data_(BL0906_TEMPERATURE, BL0906_TREF, this->temperature_sensor_);
 | 
			
		||||
  } else if (this->current_channel_ == 1) {
 | 
			
		||||
    this->read_data_(BL0906_I_1_RMS, BL0906_IREF, this->current_1_sensor_);
 | 
			
		||||
    this->read_data_(BL0906_WATT_1, BL0906_PREF, this->power_1_sensor_);
 | 
			
		||||
    this->read_data_(BL0906_CF_1_CNT, BL0906_EREF, this->energy_1_sensor_);
 | 
			
		||||
  } else if (this->current_channel_ == 2) {
 | 
			
		||||
    this->read_data_(BL0906_I_2_RMS, BL0906_IREF, this->current_2_sensor_);
 | 
			
		||||
    this->read_data_(BL0906_WATT_2, BL0906_PREF, this->power_2_sensor_);
 | 
			
		||||
    this->read_data_(BL0906_CF_2_CNT, BL0906_EREF, this->energy_2_sensor_);
 | 
			
		||||
  } else if (this->current_channel_ == 3) {
 | 
			
		||||
    this->read_data_(BL0906_I_3_RMS, BL0906_IREF, this->current_3_sensor_);
 | 
			
		||||
    this->read_data_(BL0906_WATT_3, BL0906_PREF, this->power_3_sensor_);
 | 
			
		||||
    this->read_data_(BL0906_CF_3_CNT, BL0906_EREF, this->energy_3_sensor_);
 | 
			
		||||
  } else if (this->current_channel_ == 4) {
 | 
			
		||||
    this->read_data_(BL0906_I_4_RMS, BL0906_IREF, this->current_4_sensor_);
 | 
			
		||||
    this->read_data_(BL0906_WATT_4, BL0906_PREF, this->power_4_sensor_);
 | 
			
		||||
    this->read_data_(BL0906_CF_4_CNT, BL0906_EREF, this->energy_4_sensor_);
 | 
			
		||||
  } else if (this->current_channel_ == 5) {
 | 
			
		||||
    this->read_data_(BL0906_I_5_RMS, BL0906_IREF, this->current_5_sensor_);
 | 
			
		||||
    this->read_data_(BL0906_WATT_5, BL0906_PREF, this->power_5_sensor_);
 | 
			
		||||
    this->read_data_(BL0906_CF_5_CNT, BL0906_EREF, this->energy_5_sensor_);
 | 
			
		||||
  } else if (this->current_channel_ == 6) {
 | 
			
		||||
    this->read_data_(BL0906_I_6_RMS, BL0906_IREF, this->current_6_sensor_);
 | 
			
		||||
    this->read_data_(BL0906_WATT_6, BL0906_PREF, this->power_6_sensor_);
 | 
			
		||||
    this->read_data_(BL0906_CF_6_CNT, BL0906_EREF, this->energy_6_sensor_);
 | 
			
		||||
  } else if (this->current_channel_ == UINT8_MAX - 2) {
 | 
			
		||||
    // Frequency
 | 
			
		||||
    this->read_data_(BL0906_FREQUENCY, BL0906_FREF, frequency_sensor_);
 | 
			
		||||
    // Voltage
 | 
			
		||||
    this->read_data_(BL0906_V_RMS, BL0906_UREF, voltage_sensor_);
 | 
			
		||||
  } else if (this->current_channel_ == UINT8_MAX - 1) {
 | 
			
		||||
    // Total power
 | 
			
		||||
    this->read_data_(BL0906_WATT_SUM, BL0906_WATT, this->total_power_sensor_);
 | 
			
		||||
    // Total Energy
 | 
			
		||||
    this->read_data_(BL0906_CF_SUM_CNT, BL0906_CF, this->total_energy_sensor_);
 | 
			
		||||
  } else {
 | 
			
		||||
    this->current_channel_ = UINT8_MAX - 2;  // Go to frequency and voltage
 | 
			
		||||
    return;
 | 
			
		||||
  }
 | 
			
		||||
  this->current_channel_++;
 | 
			
		||||
  this->handle_actions_();
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void BL0906::setup() {
 | 
			
		||||
  while (this->available())
 | 
			
		||||
    this->flush();
 | 
			
		||||
  this->write_array(USR_WRPROT_WITABLE, sizeof(USR_WRPROT_WITABLE));
 | 
			
		||||
  // Calibration (1: register address; 2: value before calibration; 3: value after calibration)
 | 
			
		||||
  this->bias_correction_(BL0906_RMSOS_1, 0.01600, 0);  // Calibration current_1
 | 
			
		||||
  this->bias_correction_(BL0906_RMSOS_2, 0.01500, 0);
 | 
			
		||||
  this->bias_correction_(BL0906_RMSOS_3, 0.01400, 0);
 | 
			
		||||
  this->bias_correction_(BL0906_RMSOS_4, 0.01300, 0);
 | 
			
		||||
  this->bias_correction_(BL0906_RMSOS_5, 0.01200, 0);
 | 
			
		||||
  this->bias_correction_(BL0906_RMSOS_6, 0.01200, 0);  // Calibration current_6
 | 
			
		||||
 | 
			
		||||
  this->write_array(USR_WRPROT_ONLYREAD, sizeof(USR_WRPROT_ONLYREAD));
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void BL0906::update() { this->current_channel_ = 0; }
 | 
			
		||||
 | 
			
		||||
size_t BL0906::enqueue_action_(ActionCallbackFuncPtr function) {
 | 
			
		||||
  this->action_queue_.push_back(function);
 | 
			
		||||
  return this->action_queue_.size();
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void BL0906::handle_actions_() {
 | 
			
		||||
  if (this->action_queue_.empty()) {
 | 
			
		||||
    return;
 | 
			
		||||
  }
 | 
			
		||||
  ActionCallbackFuncPtr ptr_func = nullptr;
 | 
			
		||||
  for (int i = 0; i < this->action_queue_.size(); i++) {
 | 
			
		||||
    ptr_func = this->action_queue_[i];
 | 
			
		||||
    if (ptr_func) {
 | 
			
		||||
      ESP_LOGI(TAG, "HandleActionCallback[%d]...", i);
 | 
			
		||||
      (this->*ptr_func)();
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  while (this->available()) {
 | 
			
		||||
    this->read();
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  this->action_queue_.clear();
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Reset energy
 | 
			
		||||
void BL0906::reset_energy_() {
 | 
			
		||||
  this->write_array(BL0906_INIT[0], 6);
 | 
			
		||||
  delay(1);
 | 
			
		||||
  this->flush();
 | 
			
		||||
 | 
			
		||||
  ESP_LOGW(TAG, "RMSOS:%02X%02X%02X%02X%02X%02X", BL0906_INIT[0][0], BL0906_INIT[0][1], BL0906_INIT[0][2],
 | 
			
		||||
           BL0906_INIT[0][3], BL0906_INIT[0][4], BL0906_INIT[0][5]);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Read data
 | 
			
		||||
void BL0906::read_data_(const uint8_t address, const float reference, sensor::Sensor *sensor) {
 | 
			
		||||
  if (sensor == nullptr) {
 | 
			
		||||
    return;
 | 
			
		||||
  }
 | 
			
		||||
  DataPacket buffer;
 | 
			
		||||
  ube24_t data_u24;
 | 
			
		||||
  sbe24_t data_s24;
 | 
			
		||||
  float value = 0;
 | 
			
		||||
 | 
			
		||||
  bool signed_result = reference == BL0906_TREF || reference == BL0906_WATT || reference == BL0906_PREF;
 | 
			
		||||
 | 
			
		||||
  this->write_byte(BL0906_READ_COMMAND);
 | 
			
		||||
  this->write_byte(address);
 | 
			
		||||
  if (this->read_array((uint8_t *) &buffer, sizeof(buffer) - 1)) {
 | 
			
		||||
    if (bl0906_checksum(address, &buffer) == buffer.checksum) {
 | 
			
		||||
      if (signed_result) {
 | 
			
		||||
        data_s24.l = buffer.l;
 | 
			
		||||
        data_s24.m = buffer.m;
 | 
			
		||||
        data_s24.h = buffer.h;
 | 
			
		||||
      } else {
 | 
			
		||||
        data_u24.l = buffer.l;
 | 
			
		||||
        data_u24.m = buffer.m;
 | 
			
		||||
        data_u24.h = buffer.h;
 | 
			
		||||
      }
 | 
			
		||||
    } else {
 | 
			
		||||
      ESP_LOGW(TAG, "Junk on wire. Throwing away partial message");
 | 
			
		||||
      while (read() >= 0)
 | 
			
		||||
        ;
 | 
			
		||||
      return;
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
  // Power
 | 
			
		||||
  if (reference == BL0906_PREF) {
 | 
			
		||||
    value = (float) to_int32_t(data_s24) * reference;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // Total power
 | 
			
		||||
  if (reference == BL0906_WATT) {
 | 
			
		||||
    value = (float) to_int32_t(data_s24) * reference;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // Voltage, current, power, total power
 | 
			
		||||
  if (reference == BL0906_UREF || reference == BL0906_IREF || reference == BL0906_EREF || reference == BL0906_CF) {
 | 
			
		||||
    value = (float) to_uint32_t(data_u24) * reference;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // Frequency
 | 
			
		||||
  if (reference == BL0906_FREF) {
 | 
			
		||||
    value = reference / (float) to_uint32_t(data_u24);
 | 
			
		||||
  }
 | 
			
		||||
  // Chip temperature
 | 
			
		||||
  if (reference == BL0906_TREF) {
 | 
			
		||||
    value = (float) to_int32_t(data_s24);
 | 
			
		||||
    value = (value - 64) * 12.5 / 59 - 40;
 | 
			
		||||
  }
 | 
			
		||||
  sensor->publish_state(value);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// RMS offset correction
 | 
			
		||||
void BL0906::bias_correction_(uint8_t address, float measurements, float correction) {
 | 
			
		||||
  DataPacket data;
 | 
			
		||||
  float ki = 12875 * 1 * (5.1 + 5.1) * 1000 / 2000 / 1.097;  // Current coefficient
 | 
			
		||||
  float i_rms0 = measurements * ki;
 | 
			
		||||
  float i_rms = correction * ki;
 | 
			
		||||
  int32_t value = (i_rms * i_rms - i_rms0 * i_rms0) / 256;
 | 
			
		||||
  data.l = value << 24 >> 24;
 | 
			
		||||
  data.m = value << 16 >> 24;
 | 
			
		||||
  if (value < 0) {
 | 
			
		||||
    data.h = (value << 8 >> 24) | 0b10000000;
 | 
			
		||||
  }
 | 
			
		||||
  data.address = bl0906_checksum(address, &data);
 | 
			
		||||
  ESP_LOGV(TAG, "RMSOS:%02X%02X%02X%02X%02X%02X", BL0906_WRITE_COMMAND, address, data.l, data.m, data.h, data.address);
 | 
			
		||||
  this->write_byte(BL0906_WRITE_COMMAND);
 | 
			
		||||
  this->write_byte(address);
 | 
			
		||||
  this->write_byte(data.l);
 | 
			
		||||
  this->write_byte(data.m);
 | 
			
		||||
  this->write_byte(data.h);
 | 
			
		||||
  this->write_byte(data.address);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void BL0906::dump_config() {
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "BL0906:");
 | 
			
		||||
  LOG_SENSOR("  ", "Voltage", this->voltage_sensor_);
 | 
			
		||||
 | 
			
		||||
  LOG_SENSOR("  ", "Current1", this->current_1_sensor_);
 | 
			
		||||
  LOG_SENSOR("  ", "Current2", this->current_2_sensor_);
 | 
			
		||||
  LOG_SENSOR("  ", "Current3", this->current_3_sensor_);
 | 
			
		||||
  LOG_SENSOR("  ", "Current4", this->current_4_sensor_);
 | 
			
		||||
  LOG_SENSOR("  ", "Current5", this->current_5_sensor_);
 | 
			
		||||
  LOG_SENSOR("  ", "Current6", this->current_6_sensor_);
 | 
			
		||||
 | 
			
		||||
  LOG_SENSOR("  ", "Power1", this->power_1_sensor_);
 | 
			
		||||
  LOG_SENSOR("  ", "Power2", this->power_2_sensor_);
 | 
			
		||||
  LOG_SENSOR("  ", "Power3", this->power_3_sensor_);
 | 
			
		||||
  LOG_SENSOR("  ", "Power4", this->power_4_sensor_);
 | 
			
		||||
  LOG_SENSOR("  ", "Power5", this->power_5_sensor_);
 | 
			
		||||
  LOG_SENSOR("  ", "Power6", this->power_6_sensor_);
 | 
			
		||||
 | 
			
		||||
  LOG_SENSOR("  ", "Energy1", this->energy_1_sensor_);
 | 
			
		||||
  LOG_SENSOR("  ", "Energy2", this->energy_2_sensor_);
 | 
			
		||||
  LOG_SENSOR("  ", "Energy3", this->energy_3_sensor_);
 | 
			
		||||
  LOG_SENSOR("  ", "Energy4", this->energy_4_sensor_);
 | 
			
		||||
  LOG_SENSOR("  ", "Energy5", this->energy_5_sensor_);
 | 
			
		||||
  LOG_SENSOR("  ", "Energy6", this->energy_6_sensor_);
 | 
			
		||||
 | 
			
		||||
  LOG_SENSOR("  ", "Total Power", this->total_power_sensor_);
 | 
			
		||||
  LOG_SENSOR("  ", "Total Energy", this->total_energy_sensor_);
 | 
			
		||||
  LOG_SENSOR("  ", "Frequency", this->frequency_sensor_);
 | 
			
		||||
  LOG_SENSOR("  ", "Temperature", this->temperature_sensor_);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
}  // namespace bl0906
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
@@ -1,96 +0,0 @@
 | 
			
		||||
#pragma once
 | 
			
		||||
 | 
			
		||||
#include "esphome/components/sensor/sensor.h"
 | 
			
		||||
#include "esphome/components/uart/uart.h"
 | 
			
		||||
#include "esphome/core/automation.h"
 | 
			
		||||
#include "esphome/core/component.h"
 | 
			
		||||
#include "esphome/core/datatypes.h"
 | 
			
		||||
 | 
			
		||||
// https://www.belling.com.cn/media/file_object/bel_product/BL0906/datasheet/BL0906_V1.02_cn.pdf
 | 
			
		||||
// https://www.belling.com.cn/media/file_object/bel_product/BL0906/guide/BL0906%20APP%20Note_V1.02.pdf
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace bl0906 {
 | 
			
		||||
 | 
			
		||||
struct DataPacket {  // NOLINT(altera-struct-pack-align)
 | 
			
		||||
  uint8_t l{0};
 | 
			
		||||
  uint8_t m{0};
 | 
			
		||||
  uint8_t h{0};
 | 
			
		||||
  uint8_t checksum;  // checksum
 | 
			
		||||
  uint8_t address;
 | 
			
		||||
} __attribute__((packed));
 | 
			
		||||
 | 
			
		||||
struct ube24_t {  // NOLINT(readability-identifier-naming,altera-struct-pack-align)
 | 
			
		||||
  uint8_t l{0};
 | 
			
		||||
  uint8_t m{0};
 | 
			
		||||
  uint8_t h{0};
 | 
			
		||||
} __attribute__((packed));
 | 
			
		||||
 | 
			
		||||
struct sbe24_t {  // NOLINT(readability-identifier-naming,altera-struct-pack-align)
 | 
			
		||||
  uint8_t l{0};
 | 
			
		||||
  uint8_t m{0};
 | 
			
		||||
  int8_t h{0};
 | 
			
		||||
} __attribute__((packed));
 | 
			
		||||
 | 
			
		||||
template<typename... Ts> class ResetEnergyAction;
 | 
			
		||||
 | 
			
		||||
class BL0906;
 | 
			
		||||
 | 
			
		||||
using ActionCallbackFuncPtr = void (BL0906::*)();
 | 
			
		||||
 | 
			
		||||
class BL0906 : public PollingComponent, public uart::UARTDevice {
 | 
			
		||||
  SUB_SENSOR(voltage)
 | 
			
		||||
  SUB_SENSOR(current_1)
 | 
			
		||||
  SUB_SENSOR(current_2)
 | 
			
		||||
  SUB_SENSOR(current_3)
 | 
			
		||||
  SUB_SENSOR(current_4)
 | 
			
		||||
  SUB_SENSOR(current_5)
 | 
			
		||||
  SUB_SENSOR(current_6)
 | 
			
		||||
  SUB_SENSOR(power_1)
 | 
			
		||||
  SUB_SENSOR(power_2)
 | 
			
		||||
  SUB_SENSOR(power_3)
 | 
			
		||||
  SUB_SENSOR(power_4)
 | 
			
		||||
  SUB_SENSOR(power_5)
 | 
			
		||||
  SUB_SENSOR(power_6)
 | 
			
		||||
  SUB_SENSOR(total_power)
 | 
			
		||||
  SUB_SENSOR(energy_1)
 | 
			
		||||
  SUB_SENSOR(energy_2)
 | 
			
		||||
  SUB_SENSOR(energy_3)
 | 
			
		||||
  SUB_SENSOR(energy_4)
 | 
			
		||||
  SUB_SENSOR(energy_5)
 | 
			
		||||
  SUB_SENSOR(energy_6)
 | 
			
		||||
  SUB_SENSOR(total_energy)
 | 
			
		||||
  SUB_SENSOR(frequency)
 | 
			
		||||
  SUB_SENSOR(temperature)
 | 
			
		||||
 | 
			
		||||
 public:
 | 
			
		||||
  void loop() override;
 | 
			
		||||
 | 
			
		||||
  void update() override;
 | 
			
		||||
  void setup() override;
 | 
			
		||||
  void dump_config() override;
 | 
			
		||||
 | 
			
		||||
 protected:
 | 
			
		||||
  template<typename... Ts> friend class ResetEnergyAction;
 | 
			
		||||
 | 
			
		||||
  void reset_energy_();
 | 
			
		||||
 | 
			
		||||
  void read_data_(uint8_t address, float reference, sensor::Sensor *sensor);
 | 
			
		||||
 | 
			
		||||
  void bias_correction_(uint8_t address, float measurements, float correction);
 | 
			
		||||
 | 
			
		||||
  uint8_t current_channel_{0};
 | 
			
		||||
  size_t enqueue_action_(ActionCallbackFuncPtr function);
 | 
			
		||||
  void handle_actions_();
 | 
			
		||||
 | 
			
		||||
 private:
 | 
			
		||||
  std::vector<ActionCallbackFuncPtr> action_queue_{};
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
template<typename... Ts> class ResetEnergyAction : public Action<Ts...>, public Parented<BL0906> {
 | 
			
		||||
 public:
 | 
			
		||||
  void play(Ts... x) override { this->parent_->enqueue_action_(&BL0906::reset_energy_); }
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
}  // namespace bl0906
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
@@ -1,4 +0,0 @@
 | 
			
		||||
# const.py
 | 
			
		||||
ICON_ENERGY = "mdi:lightning-bolt"
 | 
			
		||||
ICON_FREQUENCY = "mdi:cosine-wave"
 | 
			
		||||
ICON_VOLTAGE = "mdi:sine-wave"
 | 
			
		||||
@@ -1,122 +0,0 @@
 | 
			
		||||
#pragma once
 | 
			
		||||
#include <cstdint>
 | 
			
		||||
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace bl0906 {
 | 
			
		||||
 | 
			
		||||
// Total power conversion
 | 
			
		||||
static const float BL0906_WATT = 16 * 1.097 * 1.097 * (20000 + 20000 + 20000 + 20000 + 20000) /
 | 
			
		||||
                                 (40.41259 * ((5.1 + 5.1) * 1000 / 2000) * 1 * 100 * 1 * 1000);
 | 
			
		||||
// Total Energy conversion
 | 
			
		||||
static const float BL0906_CF = 16 * 4194304 * 0.032768 * 16 /
 | 
			
		||||
                               (3600000 * 16 *
 | 
			
		||||
                                (40.4125 * ((5.1 + 5.1) * 1000 / 2000) * 1 * 100 * 1 * 1000 /
 | 
			
		||||
                                 (1.097 * 1.097 * (20000 + 20000 + 20000 + 20000 + 20000))));
 | 
			
		||||
// Frequency conversion
 | 
			
		||||
static const float BL0906_FREF = 10000000;
 | 
			
		||||
// Temperature conversion
 | 
			
		||||
static const float BL0906_TREF = 12.5 / 59 - 40;
 | 
			
		||||
// Current conversion
 | 
			
		||||
static const float BL0906_IREF = 1.097 / (12875 * 1 * (5.1 + 5.1) * 1000 / 2000);
 | 
			
		||||
// Voltage conversion
 | 
			
		||||
static const float BL0906_UREF = 1.097 * (20000 + 20000 + 20000 + 20000 + 20000) / (13162 * 1 * 100 * 1000);
 | 
			
		||||
// Power conversion
 | 
			
		||||
static const float BL0906_PREF = 1.097 * 1.097 * (20000 + 20000 + 20000 + 20000 + 20000) /
 | 
			
		||||
                                 (40.41259 * ((5.1 + 5.1) * 1000 / 2000) * 1 * 100 * 1 * 1000);
 | 
			
		||||
// Energy conversion
 | 
			
		||||
static const float BL0906_EREF = 4194304 * 0.032768 * 16 /
 | 
			
		||||
                                 (3600000 * 16 *
 | 
			
		||||
                                  (40.4125 * ((5.1 + 5.1) * 1000 / 2000) * 1 * 100 * 1 * 1000 /
 | 
			
		||||
                                   (1.097 * 1.097 * (20000 + 20000 + 20000 + 20000 + 20000))));
 | 
			
		||||
// Current coefficient
 | 
			
		||||
static const float BL0906_KI = 12875 * 1 * (5.1 + 5.1) * 1000 / 2000 / 1.097;
 | 
			
		||||
// Power coefficient
 | 
			
		||||
static const float BL0906_KP = 40.4125 * ((5.1 + 5.1) * 1000 / 2000) * 1 * 100 * 1 * 1000 / 1.097 / 1.097 /
 | 
			
		||||
                               (20000 + 20000 + 20000 + 20000 + 20000);
 | 
			
		||||
 | 
			
		||||
static const uint8_t USR_WRPROT_WITABLE[6] = {0xCA, 0x9E, 0x55, 0x55, 0x00, 0xB7};
 | 
			
		||||
static const uint8_t USR_WRPROT_ONLYREAD[6] = {0xCA, 0x9E, 0x00, 0x00, 0x00, 0x61};
 | 
			
		||||
 | 
			
		||||
static const uint8_t BL0906_READ_COMMAND = 0x35;
 | 
			
		||||
static const uint8_t BL0906_WRITE_COMMAND = 0xCA;
 | 
			
		||||
 | 
			
		||||
// Register address
 | 
			
		||||
// Voltage
 | 
			
		||||
static const uint8_t BL0906_V_RMS = 0x16;
 | 
			
		||||
 | 
			
		||||
// Total power
 | 
			
		||||
static const uint8_t BL0906_WATT_SUM = 0X2C;
 | 
			
		||||
 | 
			
		||||
// Current1~6
 | 
			
		||||
static const uint8_t BL0906_I_1_RMS = 0x0D;  // current_1
 | 
			
		||||
static const uint8_t BL0906_I_2_RMS = 0x0E;
 | 
			
		||||
static const uint8_t BL0906_I_3_RMS = 0x0F;
 | 
			
		||||
static const uint8_t BL0906_I_4_RMS = 0x10;
 | 
			
		||||
static const uint8_t BL0906_I_5_RMS = 0x13;
 | 
			
		||||
static const uint8_t BL0906_I_6_RMS = 0x14;  // current_6
 | 
			
		||||
 | 
			
		||||
// Power1~6
 | 
			
		||||
static const uint8_t BL0906_WATT_1 = 0X23;  // power_1
 | 
			
		||||
static const uint8_t BL0906_WATT_2 = 0X24;
 | 
			
		||||
static const uint8_t BL0906_WATT_3 = 0X25;
 | 
			
		||||
static const uint8_t BL0906_WATT_4 = 0X26;
 | 
			
		||||
static const uint8_t BL0906_WATT_5 = 0X29;
 | 
			
		||||
static const uint8_t BL0906_WATT_6 = 0X2A;  // power_6
 | 
			
		||||
 | 
			
		||||
// Active pulse count, unsigned
 | 
			
		||||
static const uint8_t BL0906_CF_1_CNT = 0X30;  // Channel_1
 | 
			
		||||
static const uint8_t BL0906_CF_2_CNT = 0X31;
 | 
			
		||||
static const uint8_t BL0906_CF_3_CNT = 0X32;
 | 
			
		||||
static const uint8_t BL0906_CF_4_CNT = 0X33;
 | 
			
		||||
static const uint8_t BL0906_CF_5_CNT = 0X36;
 | 
			
		||||
static const uint8_t BL0906_CF_6_CNT = 0X37;  // Channel_6
 | 
			
		||||
 | 
			
		||||
// Total active pulse count, unsigned
 | 
			
		||||
static const uint8_t BL0906_CF_SUM_CNT = 0X39;
 | 
			
		||||
 | 
			
		||||
// Voltage frequency cycle
 | 
			
		||||
static const uint8_t BL0906_FREQUENCY = 0X4E;
 | 
			
		||||
 | 
			
		||||
// Internal temperature
 | 
			
		||||
static const uint8_t BL0906_TEMPERATURE = 0X5E;
 | 
			
		||||
 | 
			
		||||
// Calibration register
 | 
			
		||||
// RMS gain adjustment register
 | 
			
		||||
static const uint8_t BL0906_RMSGN_1 = 0x6D;  // Channel_1
 | 
			
		||||
static const uint8_t BL0906_RMSGN_2 = 0x6E;
 | 
			
		||||
static const uint8_t BL0906_RMSGN_3 = 0x6F;
 | 
			
		||||
static const uint8_t BL0906_RMSGN_4 = 0x70;
 | 
			
		||||
static const uint8_t BL0906_RMSGN_5 = 0x73;
 | 
			
		||||
static const uint8_t BL0906_RMSGN_6 = 0x74;  // Channel_6
 | 
			
		||||
 | 
			
		||||
// RMS offset correction register
 | 
			
		||||
static const uint8_t BL0906_RMSOS_1 = 0x78;  // Channel_1
 | 
			
		||||
static const uint8_t BL0906_RMSOS_2 = 0x79;
 | 
			
		||||
static const uint8_t BL0906_RMSOS_3 = 0x7A;
 | 
			
		||||
static const uint8_t BL0906_RMSOS_4 = 0x7B;
 | 
			
		||||
static const uint8_t BL0906_RMSOS_5 = 0x7E;
 | 
			
		||||
static const uint8_t BL0906_RMSOS_6 = 0x7F;  // Channel_6
 | 
			
		||||
 | 
			
		||||
// Active power gain adjustment register
 | 
			
		||||
static const uint8_t BL0906_WATTGN_1 = 0xB7;  // Channel_1
 | 
			
		||||
static const uint8_t BL0906_WATTGN_2 = 0xB8;
 | 
			
		||||
static const uint8_t BL0906_WATTGN_3 = 0xB9;
 | 
			
		||||
static const uint8_t BL0906_WATTGN_4 = 0xBA;
 | 
			
		||||
static const uint8_t BL0906_WATTGN_5 = 0xBD;
 | 
			
		||||
static const uint8_t BL0906_WATTGN_6 = 0xBE;  // Channel_6
 | 
			
		||||
 | 
			
		||||
// User write protection setting register,
 | 
			
		||||
// You must first write 0x5555 to the write protection setting register before writing to other registers.
 | 
			
		||||
static const uint8_t BL0906_USR_WRPROT = 0x9E;
 | 
			
		||||
 | 
			
		||||
// Reset Register
 | 
			
		||||
static const uint8_t BL0906_SOFT_RESET = 0x9F;
 | 
			
		||||
 | 
			
		||||
const uint8_t BL0906_INIT[2][6] = {
 | 
			
		||||
    // Reset to default
 | 
			
		||||
    {BL0906_WRITE_COMMAND, BL0906_SOFT_RESET, 0x5A, 0x5A, 0x5A, 0x52},
 | 
			
		||||
    // Enable User Operation Write
 | 
			
		||||
    {BL0906_WRITE_COMMAND, BL0906_USR_WRPROT, 0x55, 0x55, 0x00, 0xB7}};
 | 
			
		||||
 | 
			
		||||
}  // namespace bl0906
 | 
			
		||||
}  // namespace esphome
 | 
			
		||||
@@ -1,185 +0,0 @@
 | 
			
		||||
from esphome import automation
 | 
			
		||||
from esphome.automation import maybe_simple_id
 | 
			
		||||
import esphome.codegen as cg
 | 
			
		||||
from esphome.components import sensor, uart
 | 
			
		||||
import esphome.config_validation as cv
 | 
			
		||||
from esphome.const import (
 | 
			
		||||
    CONF_CHANNEL,
 | 
			
		||||
    CONF_CURRENT,
 | 
			
		||||
    CONF_ENERGY,
 | 
			
		||||
    CONF_FREQUENCY,
 | 
			
		||||
    CONF_ID,
 | 
			
		||||
    CONF_NAME,
 | 
			
		||||
    CONF_POWER,
 | 
			
		||||
    CONF_TEMPERATURE,
 | 
			
		||||
    CONF_TOTAL_POWER,
 | 
			
		||||
    CONF_VOLTAGE,
 | 
			
		||||
    DEVICE_CLASS_CURRENT,
 | 
			
		||||
    DEVICE_CLASS_ENERGY,
 | 
			
		||||
    DEVICE_CLASS_FREQUENCY,
 | 
			
		||||
    DEVICE_CLASS_POWER,
 | 
			
		||||
    DEVICE_CLASS_TEMPERATURE,
 | 
			
		||||
    DEVICE_CLASS_VOLTAGE,
 | 
			
		||||
    ICON_CURRENT_AC,
 | 
			
		||||
    ICON_POWER,
 | 
			
		||||
    ICON_THERMOMETER,
 | 
			
		||||
    STATE_CLASS_MEASUREMENT,
 | 
			
		||||
    STATE_CLASS_TOTAL_INCREASING,
 | 
			
		||||
    UNIT_AMPERE,
 | 
			
		||||
    UNIT_CELSIUS,
 | 
			
		||||
    UNIT_HERTZ,
 | 
			
		||||
    UNIT_KILOWATT_HOURS,
 | 
			
		||||
    UNIT_VOLT,
 | 
			
		||||
    UNIT_WATT,
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
# Import ICONS not included in esphome's const.py, from the local components const.py
 | 
			
		||||
from .const import ICON_ENERGY, ICON_FREQUENCY, ICON_VOLTAGE
 | 
			
		||||
 | 
			
		||||
DEPENDENCIES = ["uart"]
 | 
			
		||||
AUTO_LOAD = ["bl0906"]
 | 
			
		||||
CONF_TOTAL_ENERGY = "total_energy"
 | 
			
		||||
 | 
			
		||||
bl0906_ns = cg.esphome_ns.namespace("bl0906")
 | 
			
		||||
BL0906 = bl0906_ns.class_("BL0906", cg.PollingComponent, uart.UARTDevice)
 | 
			
		||||
ResetEnergyAction = bl0906_ns.class_("ResetEnergyAction", automation.Action)
 | 
			
		||||
 | 
			
		||||
CONFIG_SCHEMA = (
 | 
			
		||||
    cv.Schema(
 | 
			
		||||
        {
 | 
			
		||||
            cv.GenerateID(): cv.declare_id(BL0906),
 | 
			
		||||
            cv.Optional(CONF_FREQUENCY): sensor.sensor_schema(
 | 
			
		||||
                icon=ICON_FREQUENCY,
 | 
			
		||||
                accuracy_decimals=0,
 | 
			
		||||
                device_class=DEVICE_CLASS_FREQUENCY,
 | 
			
		||||
                unit_of_measurement=UNIT_HERTZ,
 | 
			
		||||
                state_class=STATE_CLASS_MEASUREMENT,
 | 
			
		||||
            ),
 | 
			
		||||
            cv.Optional(CONF_TEMPERATURE): sensor.sensor_schema(
 | 
			
		||||
                icon=ICON_THERMOMETER,
 | 
			
		||||
                accuracy_decimals=0,
 | 
			
		||||
                device_class=DEVICE_CLASS_TEMPERATURE,
 | 
			
		||||
                unit_of_measurement=UNIT_CELSIUS,
 | 
			
		||||
                state_class=STATE_CLASS_MEASUREMENT,
 | 
			
		||||
            ),
 | 
			
		||||
            cv.Optional(CONF_VOLTAGE): sensor.sensor_schema(
 | 
			
		||||
                icon=ICON_VOLTAGE,
 | 
			
		||||
                accuracy_decimals=1,
 | 
			
		||||
                device_class=DEVICE_CLASS_VOLTAGE,
 | 
			
		||||
                unit_of_measurement=UNIT_VOLT,
 | 
			
		||||
                state_class=STATE_CLASS_MEASUREMENT,
 | 
			
		||||
            ),
 | 
			
		||||
            cv.Optional(CONF_TOTAL_POWER): sensor.sensor_schema(
 | 
			
		||||
                icon=ICON_POWER,
 | 
			
		||||
                accuracy_decimals=3,
 | 
			
		||||
                device_class=DEVICE_CLASS_POWER,
 | 
			
		||||
                unit_of_measurement=UNIT_WATT,
 | 
			
		||||
                state_class=STATE_CLASS_MEASUREMENT,
 | 
			
		||||
            ),
 | 
			
		||||
            cv.Optional(CONF_TOTAL_ENERGY): sensor.sensor_schema(
 | 
			
		||||
                icon=ICON_ENERGY,
 | 
			
		||||
                accuracy_decimals=3,
 | 
			
		||||
                device_class=DEVICE_CLASS_ENERGY,
 | 
			
		||||
                state_class=STATE_CLASS_TOTAL_INCREASING,
 | 
			
		||||
                unit_of_measurement=UNIT_KILOWATT_HOURS,
 | 
			
		||||
            ),
 | 
			
		||||
        }
 | 
			
		||||
    )
 | 
			
		||||
    .extend(
 | 
			
		||||
        cv.Schema(
 | 
			
		||||
            {
 | 
			
		||||
                cv.Optional(f"{CONF_CHANNEL}_{i + 1}"): cv.Schema(
 | 
			
		||||
                    {
 | 
			
		||||
                        cv.Optional(CONF_CURRENT): cv.maybe_simple_value(
 | 
			
		||||
                            sensor.sensor_schema(
 | 
			
		||||
                                icon=ICON_CURRENT_AC,
 | 
			
		||||
                                accuracy_decimals=3,
 | 
			
		||||
                                device_class=DEVICE_CLASS_CURRENT,
 | 
			
		||||
                                unit_of_measurement=UNIT_AMPERE,
 | 
			
		||||
                                state_class=STATE_CLASS_MEASUREMENT,
 | 
			
		||||
                            ),
 | 
			
		||||
                            key=CONF_NAME,
 | 
			
		||||
                        ),
 | 
			
		||||
                        cv.Optional(CONF_POWER): cv.maybe_simple_value(
 | 
			
		||||
                            sensor.sensor_schema(
 | 
			
		||||
                                icon=ICON_POWER,
 | 
			
		||||
                                accuracy_decimals=0,
 | 
			
		||||
                                device_class=DEVICE_CLASS_POWER,
 | 
			
		||||
                                unit_of_measurement=UNIT_WATT,
 | 
			
		||||
                                state_class=STATE_CLASS_MEASUREMENT,
 | 
			
		||||
                            ),
 | 
			
		||||
                            key=CONF_NAME,
 | 
			
		||||
                        ),
 | 
			
		||||
                        cv.Optional(CONF_ENERGY): cv.maybe_simple_value(
 | 
			
		||||
                            sensor.sensor_schema(
 | 
			
		||||
                                icon=ICON_ENERGY,
 | 
			
		||||
                                accuracy_decimals=3,
 | 
			
		||||
                                device_class=DEVICE_CLASS_ENERGY,
 | 
			
		||||
                                unit_of_measurement=UNIT_KILOWATT_HOURS,
 | 
			
		||||
                                state_class=STATE_CLASS_TOTAL_INCREASING,
 | 
			
		||||
                            ),
 | 
			
		||||
                            key=CONF_NAME,
 | 
			
		||||
                        ),
 | 
			
		||||
                    }
 | 
			
		||||
                )
 | 
			
		||||
                for i in range(6)
 | 
			
		||||
            }
 | 
			
		||||
        )
 | 
			
		||||
    )
 | 
			
		||||
    .extend(uart.UART_DEVICE_SCHEMA)
 | 
			
		||||
    .extend(cv.polling_component_schema("60s"))
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
FINAL_VALIDATE_SCHEMA = uart.final_validate_device_schema(
 | 
			
		||||
    "bl0906", baud_rate=19200, require_tx=True, require_rx=True
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
@automation.register_action(
 | 
			
		||||
    "bl0906.reset_energy",
 | 
			
		||||
    ResetEnergyAction,
 | 
			
		||||
    maybe_simple_id(
 | 
			
		||||
        {
 | 
			
		||||
            cv.Required(CONF_ID): cv.use_id(BL0906),
 | 
			
		||||
        }
 | 
			
		||||
    ),
 | 
			
		||||
)
 | 
			
		||||
async def reset_energy_to_code(config, action_id, template_arg, args):
 | 
			
		||||
    var = cg.new_Pvariable(action_id, template_arg)
 | 
			
		||||
    await cg.register_parented(var, config[CONF_ID])
 | 
			
		||||
    return var
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
async def to_code(config):
 | 
			
		||||
    var = cg.new_Pvariable(config[CONF_ID])
 | 
			
		||||
    await cg.register_component(var, config)
 | 
			
		||||
    await uart.register_uart_device(var, config)
 | 
			
		||||
    if frequency_config := config.get(CONF_FREQUENCY):
 | 
			
		||||
        sens = await sensor.new_sensor(frequency_config)
 | 
			
		||||
        cg.add(var.set_frequency_sensor(sens))
 | 
			
		||||
    if temperature_config := config.get(CONF_TEMPERATURE):
 | 
			
		||||
        sens = await sensor.new_sensor(temperature_config)
 | 
			
		||||
        cg.add(var.set_temperature_sensor(sens))
 | 
			
		||||
    if voltage_config := config.get(CONF_VOLTAGE):
 | 
			
		||||
        sens = await sensor.new_sensor(voltage_config)
 | 
			
		||||
        cg.add(var.set_voltage_sensor(sens))
 | 
			
		||||
 | 
			
		||||
    for i in range(6):
 | 
			
		||||
        if channel_config := config.get(f"{CONF_CHANNEL}_{i + 1}"):
 | 
			
		||||
            if current_config := channel_config.get(CONF_CURRENT):
 | 
			
		||||
                sens = await sensor.new_sensor(current_config)
 | 
			
		||||
                cg.add(getattr(var, f"set_current_{i + 1}_sensor")(sens))
 | 
			
		||||
            if power_config := channel_config.get(CONF_POWER):
 | 
			
		||||
                sens = await sensor.new_sensor(power_config)
 | 
			
		||||
                cg.add(getattr(var, f"set_power_{i + 1}_sensor")(sens))
 | 
			
		||||
            if energy_config := channel_config.get(CONF_ENERGY):
 | 
			
		||||
                sens = await sensor.new_sensor(energy_config)
 | 
			
		||||
                cg.add(getattr(var, f"set_energy_{i + 1}_sensor")(sens))
 | 
			
		||||
 | 
			
		||||
    if total_power_config := config.get(CONF_TOTAL_POWER):
 | 
			
		||||
        sens = await sensor.new_sensor(total_power_config)
 | 
			
		||||
        cg.add(var.set_total_power_sensor(sens))
 | 
			
		||||
 | 
			
		||||
    if total_energy_config := config.get(CONF_TOTAL_ENERGY):
 | 
			
		||||
        sens = await sensor.new_sensor(total_energy_config)
 | 
			
		||||
        cg.add(var.set_total_energy_sensor(sens))
 | 
			
		||||
@@ -1 +1 @@
 | 
			
		||||
CODEOWNERS = ["@dbuezas", "@dwmw2"]
 | 
			
		||||
CODEOWNERS = ["@dbuezas"]
 | 
			
		||||
 
 | 
			
		||||
@@ -41,33 +41,20 @@ static const uint32_t BL0942_REG_MODE_DEFAULT =
 | 
			
		||||
static const uint32_t BL0942_REG_SOFT_RESET_MAGIC = 0x5a5a5a;
 | 
			
		||||
static const uint32_t BL0942_REG_USR_WRPROT_MAGIC = 0x55;
 | 
			
		||||
 | 
			
		||||
// 23-byte packet, 11 bits per byte, 2400 baud: about 105ms
 | 
			
		||||
static const uint32_t PKT_TIMEOUT_MS = 200;
 | 
			
		||||
 | 
			
		||||
void BL0942::loop() {
 | 
			
		||||
  DataPacket buffer;
 | 
			
		||||
  int avail = this->available();
 | 
			
		||||
 | 
			
		||||
  if (!avail) {
 | 
			
		||||
  if (!this->available()) {
 | 
			
		||||
    return;
 | 
			
		||||
  }
 | 
			
		||||
  if (avail < sizeof(buffer)) {
 | 
			
		||||
    if (!this->rx_start_) {
 | 
			
		||||
      this->rx_start_ = millis();
 | 
			
		||||
    } else if (millis() > this->rx_start_ + PKT_TIMEOUT_MS) {
 | 
			
		||||
      ESP_LOGW(TAG, "Junk on wire. Throwing away partial message (%d bytes)", avail);
 | 
			
		||||
      this->read_array((uint8_t *) &buffer, avail);
 | 
			
		||||
      this->rx_start_ = 0;
 | 
			
		||||
    }
 | 
			
		||||
    return;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  if (this->read_array((uint8_t *) &buffer, sizeof(buffer))) {
 | 
			
		||||
    if (this->validate_checksum_(&buffer)) {
 | 
			
		||||
      this->received_package_(&buffer);
 | 
			
		||||
    }
 | 
			
		||||
  } else {
 | 
			
		||||
    ESP_LOGW(TAG, "Junk on wire. Throwing away partial message");
 | 
			
		||||
    while (read() >= 0)
 | 
			
		||||
      ;
 | 
			
		||||
  }
 | 
			
		||||
  this->rx_start_ = 0;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
bool BL0942::validate_checksum_(DataPacket *data) {
 | 
			
		||||
@@ -122,23 +109,8 @@ void BL0942::update() {
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void BL0942::setup() {
 | 
			
		||||
  // If either current or voltage references are set explicitly by the user,
 | 
			
		||||
  // calculate the power reference from it unless that is also explicitly set.
 | 
			
		||||
  if ((this->current_reference_set_ || this->voltage_reference_set_) && !this->power_reference_set_) {
 | 
			
		||||
    this->power_reference_ = (this->voltage_reference_ * this->current_reference_ * 3537.0 / 305978.0) / 73989.0;
 | 
			
		||||
    this->power_reference_set_ = true;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // Similarly for energy reference, if the power reference was set by the user
 | 
			
		||||
  // either implicitly or explicitly.
 | 
			
		||||
  if (this->power_reference_set_ && !this->energy_reference_set_) {
 | 
			
		||||
    this->energy_reference_ = this->power_reference_ * 3600000 / 419430.4;
 | 
			
		||||
    this->energy_reference_set_ = true;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  this->write_reg_(BL0942_REG_USR_WRPROT, BL0942_REG_USR_WRPROT_MAGIC);
 | 
			
		||||
  if (this->reset_)
 | 
			
		||||
    this->write_reg_(BL0942_REG_SOFT_RESET, BL0942_REG_SOFT_RESET_MAGIC);
 | 
			
		||||
  this->write_reg_(BL0942_REG_SOFT_RESET, BL0942_REG_SOFT_RESET_MAGIC);
 | 
			
		||||
 | 
			
		||||
  uint32_t mode = BL0942_REG_MODE_DEFAULT;
 | 
			
		||||
  mode |= BL0942_REG_MODE_RMS_UPDATE_SEL; /* 800ms refresh time */
 | 
			
		||||
@@ -161,17 +133,10 @@ void BL0942::received_package_(DataPacket *data) {
 | 
			
		||||
    return;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  // cf_cnt is only 24 bits, so track overflows
 | 
			
		||||
  uint32_t cf_cnt = (uint24_t) data->cf_cnt;
 | 
			
		||||
  cf_cnt |= this->prev_cf_cnt_ & 0xff000000;
 | 
			
		||||
  if (cf_cnt < this->prev_cf_cnt_) {
 | 
			
		||||
    cf_cnt += 0x1000000;
 | 
			
		||||
  }
 | 
			
		||||
  this->prev_cf_cnt_ = cf_cnt;
 | 
			
		||||
 | 
			
		||||
  float v_rms = (uint24_t) data->v_rms / voltage_reference_;
 | 
			
		||||
  float i_rms = (uint24_t) data->i_rms / current_reference_;
 | 
			
		||||
  float watt = (int24_t) data->watt / power_reference_;
 | 
			
		||||
  uint32_t cf_cnt = (uint24_t) data->cf_cnt;
 | 
			
		||||
  float total_energy_consumption = cf_cnt / energy_reference_;
 | 
			
		||||
  float frequency = 1000000.0f / data->frequency;
 | 
			
		||||
 | 
			
		||||
@@ -197,18 +162,13 @@ void BL0942::received_package_(DataPacket *data) {
 | 
			
		||||
 | 
			
		||||
void BL0942::dump_config() {  // NOLINT(readability-function-cognitive-complexity)
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "BL0942:");
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "  Reset: %s", TRUEFALSE(this->reset_));
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "  Address: %d", this->address_);
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "  Nominal line frequency: %d Hz", this->line_freq_);
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "  Current reference: %f", this->current_reference_);
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "  Energy reference: %f", this->energy_reference_);
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "  Power reference: %f", this->power_reference_);
 | 
			
		||||
  ESP_LOGCONFIG(TAG, "  Voltage reference: %f", this->voltage_reference_);
 | 
			
		||||
  LOG_SENSOR("", "Voltage", this->voltage_sensor_);
 | 
			
		||||
  LOG_SENSOR("", "Current", this->current_sensor_);
 | 
			
		||||
  LOG_SENSOR("", "Power", this->power_sensor_);
 | 
			
		||||
  LOG_SENSOR("", "Energy", this->energy_sensor_);
 | 
			
		||||
  LOG_SENSOR("", "Frequency", this->frequency_sensor_);
 | 
			
		||||
  LOG_SENSOR("", "frequency", this->frequency_sensor_);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
}  // namespace bl0942
 | 
			
		||||
 
 | 
			
		||||
@@ -8,57 +8,6 @@
 | 
			
		||||
namespace esphome {
 | 
			
		||||
namespace bl0942 {
 | 
			
		||||
 | 
			
		||||
// The BL0942 IC is "calibration-free", which means that it doesn't care
 | 
			
		||||
// at all about calibration, and that's left to software. It measures a
 | 
			
		||||
// voltage differential on its IP/IN pins which linearly proportional to
 | 
			
		||||
// the current flow, and another on its VP pin which is proportional to
 | 
			
		||||
// the line voltage. It never knows the actual calibration; the values
 | 
			
		||||
// it reports are solely in terms of those inputs.
 | 
			
		||||
//
 | 
			
		||||
// The datasheet refers to the input voltages as I(A) and V(V), both
 | 
			
		||||
// in millivolts. It measures them against a reference voltage Vref,
 | 
			
		||||
// which is typically 1.218V (but that absolute value is meaningless
 | 
			
		||||
// without the actual calibration anyway).
 | 
			
		||||
//
 | 
			
		||||
// The reported I_RMS value is 305978 I(A)/Vref, and the reported V_RMS
 | 
			
		||||
// value is 73989 V(V)/Vref. So we can calibrate those by applying a
 | 
			
		||||
// simple meter with a resistive load.
 | 
			
		||||
//
 | 
			
		||||
// The chip also measures the phase difference between voltage and
 | 
			
		||||
// current, and uses it to calculate the power factor (cos φ). It
 | 
			
		||||
// reports the WATT value of 3537 * I_RMS * V_RMS * cos φ).
 | 
			
		||||
//
 | 
			
		||||
// It also integrates total energy based on the WATT value. The time for
 | 
			
		||||
// one CF_CNT pulse is 1638.4*256 / WATT.
 | 
			
		||||
//
 | 
			
		||||
// So... how do we calibrate that?
 | 
			
		||||
//
 | 
			
		||||
// Using a simple resistive load and an external meter, we can measure
 | 
			
		||||
// the true voltage and current for a given V_RMS and I_RMS reading,
 | 
			
		||||
// to calculate BL0942_UREF and BL0942_IREF. Those are in units of
 | 
			
		||||
// "305978 counts per amp" or "73989 counts per volt" respectively.
 | 
			
		||||
//
 | 
			
		||||
// We can derive BL0942_PREF from those. Let's eliminate the weird
 | 
			
		||||
// factors and express the calibration in plain counts per volt/amp:
 | 
			
		||||
// UREF1 = UREF/73989, IREF1 = IREF/305978.
 | 
			
		||||
//
 | 
			
		||||
// Next... the true power in Watts is V * I * cos φ, so that's equal
 | 
			
		||||
// to WATT/3537 * IREF1 * UREF1. Which means
 | 
			
		||||
// BL0942_PREF = BL0942_UREF * BL0942_IREF * 3537 / 305978 / 73989.
 | 
			
		||||
//
 | 
			
		||||
// Finally the accumulated energy. The period of a CF_CNT count is
 | 
			
		||||
// 1638.4*256 / WATT seconds, or 419230.4 / WATT seconds. Which means
 | 
			
		||||
// the energy represented by a CN_CNT pulse is 419230.4 WATT-seconds.
 | 
			
		||||
// Factoring in the calibration, that's 419230.4 / BL0942_PREF actual
 | 
			
		||||
// Watt-seconds (or Joules, as the physicists like to call them).
 | 
			
		||||
//
 | 
			
		||||
// But we're not being physicists today; we we're being engineers, so
 | 
			
		||||
// we want to convert to kWh instead. Which we do by dividing by 1000
 | 
			
		||||
// and then by 3600, so the energy in kWh is
 | 
			
		||||
// CF_CNT * 419230.4 / BL0942_PREF / 3600000
 | 
			
		||||
//
 | 
			
		||||
// Which makes BL0952_EREF = BL0942_PREF * 3600000 / 419430.4
 | 
			
		||||
 | 
			
		||||
static const float BL0942_PREF = 596;              // taken from tasmota
 | 
			
		||||
static const float BL0942_UREF = 15873.35944299;   // should be 73989/1.218
 | 
			
		||||
static const float BL0942_IREF = 251213.46469622;  // 305978/1.218
 | 
			
		||||
@@ -93,23 +42,6 @@ class BL0942 : public PollingComponent, public uart::UARTDevice {
 | 
			
		||||
  void set_frequency_sensor(sensor::Sensor *frequency_sensor) { frequency_sensor_ = frequency_sensor; }
 | 
			
		||||
  void set_line_freq(LineFrequency freq) { this->line_freq_ = freq; }
 | 
			
		||||
  void set_address(uint8_t address) { this->address_ = address; }
 | 
			
		||||
  void set_reset(bool reset) { this->reset_ = reset; }
 | 
			
		||||
  void set_current_reference(float current_ref) {
 | 
			
		||||
    this->current_reference_ = current_ref;
 | 
			
		||||
    this->current_reference_set_ = true;
 | 
			
		||||
  }
 | 
			
		||||
  void set_energy_reference(float energy_ref) {
 | 
			
		||||
    this->energy_reference_ = energy_ref;
 | 
			
		||||
    this->energy_reference_set_ = true;
 | 
			
		||||
  }
 | 
			
		||||
  void set_power_reference(float power_ref) {
 | 
			
		||||
    this->power_reference_ = power_ref;
 | 
			
		||||
    this->power_reference_set_ = true;
 | 
			
		||||
  }
 | 
			
		||||
  void set_voltage_reference(float voltage_ref) {
 | 
			
		||||
    this->voltage_reference_ = voltage_ref;
 | 
			
		||||
    this->voltage_reference_set_ = true;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  void loop() override;
 | 
			
		||||
  void update() override;
 | 
			
		||||
@@ -127,21 +59,14 @@ class BL0942 : public PollingComponent, public uart::UARTDevice {
 | 
			
		||||
 | 
			
		||||
  // Divide by this to turn into Watt
 | 
			
		||||
  float power_reference_ = BL0942_PREF;
 | 
			
		||||
  bool power_reference_set_ = false;
 | 
			
		||||
  // Divide by this to turn into Volt
 | 
			
		||||
  float voltage_reference_ = BL0942_UREF;
 | 
			
		||||
  bool voltage_reference_set_ = false;
 | 
			
		||||
  // Divide by this to turn into Ampere
 | 
			
		||||
  float current_reference_ = BL0942_IREF;
 | 
			
		||||
  bool current_reference_set_ = false;
 | 
			
		||||
  // Divide by this to turn into kWh
 | 
			
		||||
  float energy_reference_ = BL0942_EREF;
 | 
			
		||||
  bool energy_reference_set_ = false;
 | 
			
		||||
  uint8_t address_ = 0;
 | 
			
		||||
  bool reset_ = false;
 | 
			
		||||
  LineFrequency line_freq_ = LINE_FREQUENCY_50HZ;
 | 
			
		||||
  uint32_t rx_start_ = 0;
 | 
			
		||||
  uint32_t prev_cf_cnt_ = 0;
 | 
			
		||||
 | 
			
		||||
  bool validate_checksum_(DataPacket *data);
 | 
			
		||||
  int read_reg_(uint8_t reg);
 | 
			
		||||
 
 | 
			
		||||
@@ -24,12 +24,6 @@ from esphome.const import (
 | 
			
		||||
    UNIT_WATT,
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
CONF_CURRENT_REFERENCE = "current_reference"
 | 
			
		||||
CONF_ENERGY_REFERENCE = "energy_reference"
 | 
			
		||||
CONF_POWER_REFERENCE = "power_reference"
 | 
			
		||||
CONF_RESET = "reset"
 | 
			
		||||
CONF_VOLTAGE_REFERENCE = "voltage_reference"
 | 
			
		||||
 | 
			
		||||
DEPENDENCIES = ["uart"]
 | 
			
		||||
 | 
			
		||||
bl0942_ns = cg.esphome_ns.namespace("bl0942")
 | 
			
		||||
@@ -59,19 +53,19 @@ CONFIG_SCHEMA = (
 | 
			
		||||
            ),
 | 
			
		||||
            cv.Optional(CONF_POWER): sensor.sensor_schema(
 | 
			
		||||
                unit_of_measurement=UNIT_WATT,
 | 
			
		||||
                accuracy_decimals=1,
 | 
			
		||||
                accuracy_decimals=0,
 | 
			
		||||
                device_class=DEVICE_CLASS_POWER,
 | 
			
		||||
                state_class=STATE_CLASS_MEASUREMENT,
 | 
			
		||||
            ),
 | 
			
		||||
            cv.Optional(CONF_ENERGY): sensor.sensor_schema(
 | 
			
		||||
                unit_of_measurement=UNIT_KILOWATT_HOURS,
 | 
			
		||||
                accuracy_decimals=3,
 | 
			
		||||
                accuracy_decimals=0,
 | 
			
		||||
                device_class=DEVICE_CLASS_ENERGY,
 | 
			
		||||
                state_class=STATE_CLASS_TOTAL_INCREASING,
 | 
			
		||||
            ),
 | 
			
		||||
            cv.Optional(CONF_FREQUENCY): sensor.sensor_schema(
 | 
			
		||||
                unit_of_measurement=UNIT_HERTZ,
 | 
			
		||||
                accuracy_decimals=2,
 | 
			
		||||
                accuracy_decimals=0,
 | 
			
		||||
                device_class=DEVICE_CLASS_FREQUENCY,
 | 
			
		||||
                state_class=STATE_CLASS_MEASUREMENT,
 | 
			
		||||
            ),
 | 
			
		||||
@@ -83,11 +77,6 @@ CONFIG_SCHEMA = (
 | 
			
		||||
                ),
 | 
			
		||||
            ),
 | 
			
		||||
            cv.Optional(CONF_ADDRESS, default=0): cv.int_range(min=0, max=3),
 | 
			
		||||
            cv.Optional(CONF_RESET, default=True): cv.boolean,
 | 
			
		||||
            cv.Optional(CONF_CURRENT_REFERENCE): cv.float_,
 | 
			
		||||
            cv.Optional(CONF_ENERGY_REFERENCE): cv.float_,
 | 
			
		||||
            cv.Optional(CONF_POWER_REFERENCE): cv.float_,
 | 
			
		||||
            cv.Optional(CONF_VOLTAGE_REFERENCE): cv.float_,
 | 
			
		||||
        }
 | 
			
		||||
    )
 | 
			
		||||
    .extend(cv.polling_component_schema("60s"))
 | 
			
		||||
@@ -117,12 +106,3 @@ async def to_code(config):
 | 
			
		||||
        cg.add(var.set_frequency_sensor(sens))
 | 
			
		||||
    cg.add(var.set_line_freq(config[CONF_LINE_FREQUENCY]))
 | 
			
		||||
    cg.add(var.set_address(config[CONF_ADDRESS]))
 | 
			
		||||
    cg.add(var.set_reset(config[CONF_RESET]))
 | 
			
		||||
    if (current_reference := config.get(CONF_CURRENT_REFERENCE, None)) is not None:
 | 
			
		||||
        cg.add(var.set_current_reference(current_reference))
 | 
			
		||||
    if (voltage_reference := config.get(CONF_VOLTAGE_REFERENCE, None)) is not None:
 | 
			
		||||
        cg.add(var.set_voltage_reference(voltage_reference))
 | 
			
		||||
    if (power_reference := config.get(CONF_POWER_REFERENCE, None)) is not None:
 | 
			
		||||
        cg.add(var.set_power_reference(power_reference))
 | 
			
		||||
    if (energy_reference := config.get(CONF_ENERGY_REFERENCE, None)) is not None:
 | 
			
		||||
        cg.add(var.set_energy_reference(energy_reference))
 | 
			
		||||
 
 | 
			
		||||
Some files were not shown because too many files have changed in this diff Show More
		Reference in New Issue
	
	Block a user