Skip to content

Commit d27f8e9

Browse files
authored
Merge pull request #9272 from dhalbert/analog-esp32-doc
shared-bindings/analogio/AnalogIn.c: fix Espressif limitations doc
2 parents 5339e96 + c9b5002 commit d27f8e9

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

shared-bindings/analogio/AnalogIn.c

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,11 @@ MP_WEAK const mcu_pin_obj_t *common_hal_analogio_analogin_validate_pin(mp_obj_t
3838
//|
3939
//| :param ~microcontroller.Pin pin: the pin to read from
4040
//|
41-
//| **Limitations:** On Espressif ESP32, `AnalogIn` is not available when WiFi is in use:
42-
//| the hardware makes use of the ADC. Attempts to use `AnalogIn` will raise `espidf.IDFError`.
43-
//| On other Espressif chips, the ADC is available, but is shared with WiFi.
44-
//| WiFi use takes precedence and may temporarily cause `espidf.IDFError` to be raise.
41+
//| **Limitations:** On Espressif ESP32, pins that use ADC2 are not available when WiFi is enabled:
42+
//| the hardware makes use of ADC2.
43+
//| Attempts to use `AnalogIn` in that situation will raise `espidf.IDFError`.
44+
//| On other Espressif chips, ADC2 is available, but is shared with WiFi.
45+
//| WiFi use takes precedence and may temporarily cause `espidf.IDFError` to be raised
4546
//| when you read a value. You can retry the read.
4647
//| """
4748
//| ...

0 commit comments

Comments
 (0)