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

shared-bindings/analogio/AnalogIn.c: fix Espressif limitations doc #9272

Merged
merged 1 commit into from
May 24, 2024
Merged

shared-bindings/analogio/AnalogIn.c: fix Espressif limitations doc #9272

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 5 additions & 4 deletions shared-bindings/analogio/AnalogIn.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,11 @@ MP_WEAK const mcu_pin_obj_t *common_hal_analogio_analogin_validate_pin(mp_obj_t
//|
//| :param ~microcontroller.Pin pin: the pin to read from
//|
//| **Limitations:** On Espressif ESP32, `AnalogIn` is not available when WiFi is in use:
//| the hardware makes use of the ADC. Attempts to use `AnalogIn` will raise `espidf.IDFError`.
//| On other Espressif chips, the ADC is available, but is shared with WiFi.
//| WiFi use takes precedence and may temporarily cause `espidf.IDFError` to be raise.
//| **Limitations:** On Espressif ESP32, pins that use ADC2 are not available when WiFi is enabled:
//| the hardware makes use of ADC2.
//| Attempts to use `AnalogIn` in that situation will raise `espidf.IDFError`.
//| On other Espressif chips, ADC2 is available, but is shared with WiFi.
//| WiFi use takes precedence and may temporarily cause `espidf.IDFError` to be raised
//| when you read a value. You can retry the read.
//| """
//| ...
Expand Down