Skip to content

docs: Correct ADC default resolution statement for ESP32-S2 #11653

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

Merged
merged 3 commits into from
Aug 5, 2025
Merged

docs: Correct ADC default resolution statement for ESP32-S2 #11653

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b139bae
docs: Remove incorrect statement on ESP32-S3 default resolution
eMUQI Jul 27, 2025
6cc7a63
docs: Change ADC default resolution exception to ESP32-S2
eMUQI Jul 28, 2025
b9c0f68
docs: Specify ADC resolution errata for ESP32-S2 v0.0
eMUQI Jul 30, 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
2 changes: 1 addition & 1 deletion docs/en/api/adc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ analogReadResolution
^^^^^^^^^^^^^^^^^^^^

This function is used to set the resolution of ``analogRead`` return value. Default is 12 bits (range from 0 to 4095)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is only for the chip revision v0.0. For v1.0, the resolution is 12 bits.

Please add a reference to the ADC-112 Bit 1 of SAR ADC Does Not Flip errata.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @eMUQI, can you take a look?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @pedrominatel,
Thanks for the clarification. Just to make sure I understand correctly:
The documentation should specify that the 13-bit default resolution only applies to ESP32-S2 chip revision v0.0, and I should also add a reference to the ADC-112 Bit 1 of SAR ADC Does Not Flip errata.
Is that correct? If so, I will update the PR accordingly.
Thanks!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's right.

for all chips except ESP32-S3 where default is 13 bits (range from 0 to 8191).
for all chips except ESP32-S2 where default is 13 bits (range from 0 to 8191).
When different resolution is set, the values read will be shifted to match the given resolution.

Range is 1 - 16 .The default value will be used, if this function is not used.
Expand Down