Skip to content

Commit ced66da

Browse files
authored
[Docs] ADC and Timer API Update (+some docs fixes) (#7906)
* updated docs * remove hall sensor docs Removed Hall sensor documentation as its no longer supported in IDF-5 * Fixed ESPNow examples location in docs * Last timer refactored API + gpio small fix * AlarmWrite fix
1 parent 5128825 commit ced66da

File tree

4 files changed

+41
-260
lines changed

4 files changed

+41
-260
lines changed

Diff for: docs/source/api/adc.rst

+3-50
Original file line numberDiff line numberDiff line change
@@ -30,20 +30,20 @@ This function is used to get the ADC raw value for a given pin/ADC channel.
3030
3131
* ``pin`` GPIO pin to read analog value
3232

33-
This function will return analog raw value.
33+
This function will return analog raw value (non-calibrated).
3434

3535
analogReadMillivolts
3636
^^^^^^^^^^^^^^^^^^^^
3737

38-
This function is used to get ADC value for a given pin/ADC channel in millivolts.
38+
This function is used to get ADC raw value for a given pin/ADC channel and convert it to calibrated result in millivolts.
3939

4040
.. code-block:: arduino
4141
4242
uint32_t analogReadMilliVolts(uint8_t pin);
4343
4444
* ``pin`` GPIO pin to read analog value
4545

46-
This function will return analog value in millivolts.
46+
This function will return analog value in millivolts (calibrated).
4747

4848
analogReadResolution
4949
^^^^^^^^^^^^^^^^^^^^
@@ -62,19 +62,6 @@ Range is 1 - 16 .The default value will be used, if this function is not used.
6262
6363
* ``bits`` sets analog read resolution
6464

65-
analogSetClockDiv
66-
^^^^^^^^^^^^^^^^^
67-
68-
This function is used to set the divider for the ADC clock.
69-
70-
Range is 1 - 255. Default value is 1.
71-
72-
.. code-block:: arduino
73-
74-
void analogSetClockDiv(uint8_t clockDiv);
75-
76-
* ``clockDiv`` sets the divider for ADC clock.
77-
7865
analogSetAttenuation
7966
^^^^^^^^^^^^^^^^^^^^
8067

@@ -149,17 +136,6 @@ This function is used to set the attenuation for a specific pin/ADC channel. For
149136
* ``pin`` selects specific pin for attenuation settings.
150137
* ``attenuation`` sets the attenuation.
151138

152-
adcAttachPin
153-
^^^^^^^^^^^^
154-
155-
This function is used to attach the pin to ADC (it will also clear any other analog mode that could be on)
156-
157-
.. code-block:: arduino
158-
159-
bool adcAttachPin(uint8_t pin);
160-
161-
This function will return ``true`` if configuration is successful. Else returns ``false``.
162-
163139
ADC API specific for ESP32 chip
164140
*******************************
165141

@@ -173,30 +149,7 @@ Range is 9 - 12.
173149
.. code-block:: arduino
174150
175151
void analogSetWidth(uint8_t bits);
176-
177-
analogSetVRefPin
178-
^^^^^^^^^^^^^^^^
179-
180-
This function is used to set pin to use for ADC calibration if the esp is not already calibrated (pins 25, 26 or 27).
181-
182-
.. code-block:: arduino
183-
184-
void analogSetVRefPin(uint8_t pin);
185-
186-
* ``pin`` GPIO pin to set VRefPin for ADC calibration
187152
188-
hallRead
189-
^^^^^^^^
190-
191-
This function is used to get the ADC value of the HALL sensor conneted to pins 36(SVP) and 39(SVN).
192-
193-
.. code-block:: arduino
194-
195-
int hallRead();
196-
197-
This function will return the hall sensor value.
198-
199-
200153
Example Applications
201154
********************
202155

Diff for: docs/source/api/gpio.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ The GPIO peripheral on the ESP32 supports interruptions.
8787
attachInterrupt
8888
***************
8989

90-
The function ``attachInterruptArg`` is used to attach the interrupt to the defined pin.
90+
The function ``attachInterrupt`` is used to attach the interrupt to the defined pin.
9191

9292
.. code-block:: arduino
9393

Diff for: docs/source/api/hall_sensor.rst

-19
This file was deleted.

0 commit comments

Comments
 (0)