Unintuitive Documentation for ES8311

[whc2001]

Feedback

I tried to use the ES8311 I2S audio codec for microphone. After some failed attempts I found the following two configs can be made more clear:

1. The documentation said that MIN and MAX are also values for mic_gain. However after inspecting the source code and datasheet, those are only enum guard values to show the boundaries. When using normally these value should not be chosen.

2. The documentation said that to use microphone input you need to turn use_microphone on, however after inspecting the source code seems that it's completely incorrect. The relavent code shows that by default the codec is configured as analog (electret) microphone mode, and if use_microphone is set to true, it will switch to PDM microphone mode. The naming is somewhat misleading.

URL

https://esphome.io/components/audio_dac/es8311.html

Additional information

No response

[github-actions]

#162

[whc2001]

Seems like the central issue tracker is now closed, but the bot in this repo is still giving out the old directions? Should I direct the issue to esphome/esphome/issues?

[github-actions]

#162