Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add adc/sampling_mode doc #4601

Merged
merged 2 commits into from
Feb 10, 2025
Merged

add adc/sampling_mode doc #4601

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
429dace
add adc/sampling_mode doc
blind-oracle Jan 23, 2025
41dc441
Update components/sensor/adc.rst
jesserockz Feb 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions components/sensor/adc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,12 @@ Configuration variables:
attenuation to use. See :ref:`adc-esp32_attenuation`. Defaults to ``0db``.
- **raw** (*Optional*): Allows to read the raw ADC output without any conversion or calibration. See :ref:`adc-raw`. Defaults to ``false``.
- **samples** (*Optional*): The amount of ADC readings to take per sensor update. On the ESP32 this value is ignored if ``attenuation`` is set to ``auto``. Defaults to ``1``.
- **sampling_mode** (*Optional*): Sampling method to use when multiple samples are taken.

- ``avg`` average of all samples (**Default**)
- ``min`` minimal value from all samples
- ``max`` maximal value from all samples

- **update_interval** (*Optional*, :ref:`config-time`): The interval
to check the sensor. Defaults to ``60s``.
- All other options from :ref:`Sensor <config-sensor>`.
Expand Down