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

document Espressif AnalogIn limitations #9137

Merged
merged 1 commit into from
Apr 3, 2024
Merged

document Espressif AnalogIn limitations #9137

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: 8 additions & 1 deletion shared-bindings/analogio/AnalogIn.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,14 @@ MP_WEAK const mcu_pin_obj_t *common_hal_analogio_analogin_validate_pin(mp_obj_t
//| """Use the AnalogIn on the given pin. The reference voltage varies by
//| platform so use ``reference_voltage`` to read the configured setting.
//|
//| :param ~microcontroller.Pin pin: the pin to read from"""
//| :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.
//| when you read a value. You can retry the read.
//| """
//| ...
STATIC mp_obj_t analogio_analogin_make_new(const mp_obj_type_t *type,
mp_uint_t n_args, size_t n_kw, const mp_obj_t *args) {
Expand Down