Add deprecation notice for ESP32 Hall sensor (#3883)

This commit is contained in:
Keith Burzinski 2024-07-30 01:06:13 -05:00 committed by GitHub
parent a658adf409
commit 08a5bb6670
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -11,6 +11,12 @@ The ``esp32_hall`` sensor platform allows you to use the integrated
ESP32 chip to measure the magnitude and direction of magnetic field around the
chip (with quite poor accuracy).
.. warning::
Espressif has `removed support <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/migration-guides/release-5.x/5.0/peripherals.html?highlight=hall_sensor_read#api-changes>`__
for the ESP32's Hall sensor in IDF 5; for this reason, support for this component is
likely to be removed in a future release.
Please make sure that nothing is connected to pins ``GPIO36`` and ``GPIO39`` if this
component is enabled, as those pins are used for the internal low-noise amplifier used
by the hall sensor.