From bb15cbe2807042cd2c09e2bcf62f66c67aec62f3 Mon Sep 17 00:00:00 2001 From: Fritiof Hedman <989352+zyberzero@users.noreply.github.com> Date: Fri, 19 Dec 2025 17:30:35 +0100 Subject: [PATCH] Add sendspin functionality for Sonocottas ESP32 hifi --- esphome/sonocotta/esp32-hifi/LICENSE | 202 ++++++++++++++++++ .../sonocotta/esp32-hifi/THIRD_PARTY_NOTICES | 2 + .../esp32-hifi/esp32-sendspin-beta.yaml | 174 +++++++++++++++ 3 files changed, 378 insertions(+) create mode 100644 esphome/sonocotta/esp32-hifi/LICENSE create mode 100644 esphome/sonocotta/esp32-hifi/THIRD_PARTY_NOTICES create mode 100644 esphome/sonocotta/esp32-hifi/esp32-sendspin-beta.yaml diff --git a/esphome/sonocotta/esp32-hifi/LICENSE b/esphome/sonocotta/esp32-hifi/LICENSE new file mode 100644 index 0000000..57bc88a --- /dev/null +++ b/esphome/sonocotta/esp32-hifi/LICENSE @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/esphome/sonocotta/esp32-hifi/THIRD_PARTY_NOTICES b/esphome/sonocotta/esp32-hifi/THIRD_PARTY_NOTICES new file mode 100644 index 0000000..dbd4e8e --- /dev/null +++ b/esphome/sonocotta/esp32-hifi/THIRD_PARTY_NOTICES @@ -0,0 +1,2 @@ +MIT-licensed components: +- Home assistant voice PE, © Esphome contributors (https://github.com/esphome/home-assistant-voice-pe) diff --git a/esphome/sonocotta/esp32-hifi/esp32-sendspin-beta.yaml b/esphome/sonocotta/esp32-hifi/esp32-sendspin-beta.yaml new file mode 100644 index 0000000..8aa4dda --- /dev/null +++ b/esphome/sonocotta/esp32-hifi/esp32-sendspin-beta.yaml @@ -0,0 +1,174 @@ +# SPDX-License-Identifier: Apache-2.0 +# +# This file incorporates and is derived from material originally licensed under: +# - Apache License, Version 2.0 +# - MIT License +# +# The combined and modified work is licensed under the Apache License, Version 2.0. +# See the LICENSE file in the repository root for full license text. + +# This is based on a mix of +# - https://github.com/esphome/home-assistant-voice-pe/blob/b2cf3e52a9fd3a701d2ff917c296e8ef9032d14e/home-assistant-voice.yaml (MIT license) +# - https://github.com/sonocotta/esp32-audio-dock/blob/8f39d54b785ee3403ddc8afa4e12c99eb69c9e6a/firmware/esphome/hifi-esp32-idf.yaml (Apache 2.0 License) + + +external_components: + - source: + # https://github.com/esphome/esphome/pull/12253 + type: git + url: https://github.com/esphome/esphome + ref: 0fe230114c80b6d3378f04c777baadee178e40ad + components: [mixer] + - source: + # https://github.com/esphome/esphome/pull/12254 + type: git + url: https://github.com/esphome/esphome + ref: 1ab4b990092ae063a16cb1511a188c536fdb336e + components: [resampler] + - source: + # https://github.com/esphome/esphome/pull/12256 + type: git + url: https://github.com/esphome/esphome + ref: 047ba60f01af84513f8d5aabaa2a53074facee8f + components: [audio] + - source: + # https://github.com/esphome/esphome/pull/12258 + type: git + url: https://github.com/esphome/esphome + ref: bff22983a390352360796f8e1363127e0cd1f898 + components: [media_player] + - source: + # https://github.com/esphome/esphome/pull/12284 + type: git + url: https://github.com/esphome/esphome + ref: 9d2d2f6287a72af6397dfd93ee56fbab25c1d32f + components: [mdns, sendspin] + - source: + # https://github.com/esphome/esphome/pull/12429 + type: git + url: https://github.com/esphome/esphome + ref: 72499eaed2ed54316aca90d368053aa2e1a54f5f + refresh: 0s + components: [file, http_request, media_source, speaker_source] + +esphome: + name: test-player + friendly_name: test-player + min_version: 2025.12.0 + +esp32: + board: mhetesp32minikit + flash_size: 8MB + framework: + type: esp-idf + version: recommended + sdkconfig_options: + CONFIG_BT_ALLOCATION_FROM_SPIRAM_FIRST: "y" + CONFIG_BT_BLE_DYNAMIC_ENV_MEMORY: "y" + + CONFIG_MBEDTLS_EXTERNAL_MEM_ALLOC: "y" + CONFIG_MBEDTLS_SSL_PROTO_TLS1_3: "y" # TLS1.3 support isn't enabled by default in IDF 5.1.5 + +# Enable logging +logger: + +# Enable Home Assistant API +api: + encryption: + key: "keykeykey" + +ota: + - platform: esphome + password: "keykeykey" + +wifi: + ssid: !secret wifi_ssid + password: !secret wifi_password + + # Enable fallback hotspot (captive portal) in case wifi connection fails + ap: + ssid: "Test-Player Fallback Hotspot" + password: !secret ap_fallback + +captive_portal: + +psram: + speed: 80MHz + +i2s_audio: + i2s_lrclk_pin: GPIO25 + i2s_bclk_pin: GPIO26 + +speaker: + - platform: i2s_audio + id: speaker_id + dac_type: external + i2s_dout_pin: GPIO22 + channel: stereo + sample_rate: 48000 + timeout: never + # Virtual speakers to combine the announcement and media streams together into one output + - platform: mixer + id: mixing_speaker + output_speaker: speaker_id + num_channels: 2 + task_stack_in_psram: False + source_speakers: + - id: announcement_mixing_input + timeout: never + - id: media_mixing_input + timeout: never + + # Virtual speakers to resample each pipelines' audio, if necessary, as the mixer speaker requires the same sample rate + - platform: resampler + id: announcement_resampling_speaker + output_speaker: announcement_mixing_input + sample_rate: 48000 + bits_per_sample: 16 + - platform: resampler + id: media_resampling_speaker + output_speaker: media_mixing_input + sample_rate: 48000 + bits_per_sample: 16 + + +sendspin: + id: sendspin_hub + task_stack_in_psram: false + kalman_process_error: 0.01 + +media_source: + - platform: sendspin + id: sendspin_source +# - platform: http_request +# id: http_source +# buffer_size: 500000 + +media_player: + - platform: sendspin + id: sendspin_group_media_player + - platform: speaker_source + id: external_media_player + name: Media Player + announcement_speaker: announcement_resampling_speaker + media_speaker: media_resampling_speaker + announcement_pipeline: + format: FLAC # FLAC is the least processor intensive codec + num_channels: 1 # Stereo audio is unnecessary for announcements + sample_rate: 48000 + media_pipeline: + format: FLAC # FLAC is the least processor intensive codec + num_channels: 2 + sample_rate: 48000 + volume_increment: 0.05 + volume_min: 0.4 + volume_max: 0.85 + sources: +# - http_source + - sendspin_source + on_announcement: + - mixer_speaker.apply_ducking: + id: media_mixing_input + decibel_reduction: 20 + duration: 0.0s +