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

Jump to bottom

[Docs] Add to the ADC API documentation the analogReadMillivolts note about calibation #7862

Closed
1 task done
pedrominatel opened this issue Feb 17, 2023 · 1 comment · Fixed by #7906
Closed
1 task done

[Docs] Add to the ADC API documentation the analogReadMillivolts note about calibation #7862

pedrominatel opened this issue Feb 17, 2023 · 1 comment · Fixed by #7906
Assignees
@P-R-O-C-H-Y
Labels
Status: Solved Type: Documentation Issue pertains to Documentation of Arduino ESP32

Comments

@pedrominatel
Copy link
Member

pedrominatel commented Feb 17, 2023 •
edited
Loading

Related area

Documentation

Hardware specification

N/A

Is your feature request related to a problem?

In the analogRead function, the value is the RAW value without the calibration, but for the analogReadMillivolts the values are calibrated.

adc2_get_raw - No calibrated data
esp_adc_cal_raw_to_voltage - Calibrated data

Describe the solution you'd like

Add to the adc2_get_raw and esp_adc_cal_raw_to_voltage function descriptions in the documentation the note about the calibration. Please don't change the API, only the documentation.

Source https://github.com/espressif/arduino-esp32/blob/2.0.6/docs/source/api/adc.rst#adc-common-api

Describe alternatives you've considered

N/A

Additional context

N/A

I have checked existing list of Feature requests and the Contribution Guide

  • I confirm I have checked existing list of Feature requests and Contribution Guide.
@pedrominatel pedrominatel added the Type: Feature request Feature request for Arduino ESP32 label Feb 17, 2023
@VojtechBartoska VojtechBartoska added the Type: Documentation Issue pertains to Documentation of Arduino ESP32 label Feb 20, 2023
@VojtechBartoska VojtechBartoska removed the Type: Feature request Feature request for Arduino ESP32 label Feb 22, 2023
@P-R-O-C-H-Y P-R-O-C-H-Y mentioned this issue Feb 28, 2023
Merged
@VojtechBartoska
Copy link
Contributor

Closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@P-R-O-C-H-Y P-R-O-C-H-Y

Labels
Status: Solved Type: Documentation Issue pertains to Documentation of Arduino ESP32
Projects
Arduino ESP32 Core Project Roadmap
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Docs] ADC and Timer API Update (+some docs fixes) P-R-O-C-H-Y/arduino-esp32
3 participants
@pedrominatel @VojtechBartoska @P-R-O-C-H-Y