add adc/sampling_mode doc #4601
Conversation
WalkthroughThe pull request introduces a new optional configuration variable Changes
Suggested reviewers
Possibly related PRs
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. 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 (1)
components/sensor/adc.rst (1)
38-38: Consider enhancing the documentation with examples.To help users better understand when to use each sampling mode, consider adding:
- Example configurations showing different sampling modes
- Brief explanations of when each mode might be useful (e.g.,
maxfor detecting peaks,minfor noise floor, etc.)Example addition:
- **sampling_mode** (*Optional*): Sampling method to use when multiple samples are taken. Can be ``avg`` (average of all samples), ``min`` (minimal value from all samples), ``max`` (maximal value from all samples). Defaults to ``avg``. + + Example of using maximum sampling mode to detect voltage peaks: + + .. code-block:: yaml + + sensor: + - platform: adc + pin: GPIO32 + name: "Peak Voltage Sensor" + samples: 10 + sampling_mode: max + update_interval: 60s
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
components/sensor/adc.rst(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
components/sensor/adc.rst (1)
Pattern **: - Do not generate or add any sequence diagrams
🔇 Additional comments (1)
components/sensor/adc.rst (1)
38-38: LGTM! The documentation for the new configuration variable is clear and well-formatted.The
sampling_modeparameter is documented in a consistent style with other configuration variables, clearly listing all possible values and the default.
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Description:
Pull request in esphome with YAML changes (if applicable): esphome/esphome#8131
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
/index.rstwhen creating new documents for new components or cookbook.