add working sample code for ICS-43434 #5216
Conversation
WalkthroughThe documentation for the I²S Audio Microphone component was updated to include a horizontal separator under the "Known Devices" section and to add the ICS-43434 microphone (Adafruit I2S MEMS Mic Breakout) as a supported device, along with a sample YAML configuration for this device. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
components/microphone/i2s_audio.rst (2)
75-77: Underline length off by one characterESPHome-docs conventions keep reST underline length exactly matching the heading text.
“Known Devices” is 13 chars but the underline is 14, which renders fine but is inconsistent with the rest of the file.-Known Devices -------------- +Known Devices +-------------
100-116: Place ICS-43434 section alphabetically & keep docs predictableHeadings under “Known Devices” are currently in alpha order (M → R).
Putting the new “ICS-43434” block after RaspiAudio breaks that ordering and makes devices harder to scan.Move the whole subsection so the order becomes:
I CS-43434
M 5Stack Atom Echo
R aspiAudio Muse LuxeNo behaviour change, purely doc clarity.
Example patch outline:@@ -Known Devices ------------- - -M5Stack Atom Echo +Known Devices +------------- + +ICS-43434 +********* + +`Adafruit I2S MEMS Mic Breakout <https://www.adafruit.com/product/6049>`_ + +.. code-block:: yaml + + microphone: + - platform: i2s_audio + i2s_din_pin: GPIOXX + adc_type: external + pdm: false + sample_rate: 48000 + bits_per_sample: 32bit + channel: left + use_apll: true + +M5Stack Atom Echo *********
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
components/microphone/i2s_audio.rst(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**
⚙️ CodeRabbit Configuration File
- Do not generate or add any sequence diagrams
Files:
components/microphone/i2s_audio.rst
🧠 Learnings (1)
📓 Common learnings
Learnt from: jesserockz
PR: esphome/esphome-docs#4865
File: .github/workflows/needs-docs.yml:0-0
Timestamp: 2025-05-01T03:29:47.922Z
Learning: In the esphome-docs repository, the "current" label is automatically added by a bot to pull requests, making it a reliable indicator for the target branch.
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Description:
Add working starter code for sound sensor using an ICS-43434
Tested working with Adafruit MEMS i2s Breakout https://www.adafruit.com/product/6049
And vanilla ESP32 and XIAO ESP32-S3
Related issue (if applicable): fixes
Pull request in esphome with YAML changes (if applicable):
Checklist:
I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.Link added in
/components/index.rstwhen creating new documents for new components or cookbook.New Component Images
If you are adding a new component to ESPHome, you can automatically generate a standardized black and white component name image for the documentation.
To generate a component image:
Comment on this pull request with the following command, replacing
COMPONENT_NAMEwith your component name in UPPER_CASE format with underscores (e.g.,BME280,SHT3X,DALLAS_TEMP):The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.
Extract the SVG file and place it in the
images/folder of this repository.Use the image in your component's index table entry in
/components/index.rst.Example: For a component called "DHT22 Temperature Sensor", use: