Can I suggest you consider adding a README file to this repo with at least some basic information about its purpose just for reference?
Suggest make that README.md file maybe only contain something similar to this to explain what this voice-kit repo is all about:
Temporary development repository for experimental enhancements/improvements to voice-assistant, microphone, and media-player ESPHome components as a framework to be used in the planned voice-kit hardware platform from Nabu Casa that is on Home Assistant's roadmap for voice assistants, that is meant to act as ESP32-based reference development hardware for a Home Assistant Voice Assistant Satellite running ESPHome made to further plug-and-play experience).
* https://www.home-assistant.io/blog/2024/06/12/roadmap-2024h1#voice-assistants
Support for external XMOS DSP via I2S is being explored but one goal for this repo is to not be reliant on specific hardware configurations.
"_We are moving fast and breaking things as we figure out the best way for these components to interact, but we will add all the code to the base ESPHome project once things are stable and working well_" - kahrendt
"_Very little of the code is reliant specifically on the XMOS chip (and the few lines that are should be adaptable or won't even be there in the final version as we clean up the code), so it should be possible to add support for other DSPs in the future._" - kahrendt
See also:
- https://www.home-assistant.io/blog/2024/06/26/voice-chapter-7
- https://www.home-assistant.io/blog/2022/12/20/year-of-voice/
- https://www.home-assistant.io/voice_control/
- https://esphome.io/projects/
- https://esphome.io/components/voice_assistant.html
- https://esphome.io/components/micro_wake_word.html
- https://esphome.io/components/i2s_audio.html
- https://esphome.io/components/microphone/
- https://esphome.io/components/microphone/i2s_audio.html
- https://esphome.io/components/speaker/
- https://esphome.io/components/speaker/i2s_audio.html
- https://esphome.io/components/i2s_audio.html
- https://esphome.io/guides/audio_clips_for_i2s.html
- https://esphome.io/components/media_player/
- https://esphome.io/components/media_player/i2s_audio.html
- https://esphome.io/components/dfplayer.html
- https://esphome.io/components/esp32_improv.html
Can I suggest you consider adding a README file to this repo with at least some basic information about its purpose just for reference?
Suggest make that
README.mdfile maybe only contain something similar to this to explain what this voice-kit repo is all about: