Skip to content

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

Closed
@pedrominatel

Description

@pedrominatel

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.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions