:mod:`espidf`
=============

.. py:module:: espidf

.. autoapi-nested-parse::

   Direct access to a few ESP-IDF details. This module *should not* include any functionality
   that could be implemented by other frameworks. It should only include ESP-IDF specific
   things.



.. raw:: html

    <p>
    <details>
    <summary>Available on these boards</summary>
    <ul>
    <li> AITHinker ESP32-C3S_Kit
    <li> ATMegaZero ESP32-S2
    <li> Adafruit Feather ESP32-S2 TFT
    <li> Adafruit Feather ESP32S2
    <li> Adafruit FunHouse
    <li> Adafruit MagTag
    <li> Adafruit Metro ESP32S2
    <li> Adafruit QT Py ESP32S2
    <li> Artisense Reference Design RD00
    <li> BastWiFi
    <li> CrumpS2
    <li> ESP 12k NodeMCU
    <li> Feather ESP32S2 without PSRAM
    <li> FeatherS2
    <li> FeatherS2 Neo
    <li> FeatherS2 PreRelease
    <li> Franzininho WIFI w/Wroom
    <li> Franzininho WIFI w/Wrover
    <li> Gravitech Cucumber M
    <li> Gravitech Cucumber MS
    <li> Gravitech Cucumber R
    <li> Gravitech Cucumber RS
    <li> HMI-DevKit-1.1
    <li> Kaluga 1
    <li> LILYGO TTGO T8 ESP32-S2 w/Display
    <li> MORPHEANS MorphESP-240
    <li> MicroDev microC3
    <li> MicroDev microS2
    <li> Oak Dev Tech PixelWing ESP32S2
    <li> S2Mini
    <li> S2Pico
    <li> Saola 1 w/Wroom
    <li> Saola 1 w/Wrover
    <li> Targett Module Clip w/Wroom
    <li> Targett Module Clip w/Wrover
    <li> Thingz - Galaxia
    <li> TinyS2
    <li> nanoESP32-S2  w/Wrover
    <li> nanoESP32-S2 w/Wroom
    </ul>
    </details>
    </p>




.. py:function:: heap_caps_get_total_size() -> int

   Return the total size of the ESP-IDF, which includes the CircuitPython heap.


.. py:function:: heap_caps_get_free_size() -> int

   Return total free memory in the ESP-IDF heap.


.. py:function:: heap_caps_get_largest_free_block() -> int

   Return the size of largest free memory block in the ESP-IDF heap.


.. py:function:: erase_nvs() -> None

   Erase all data in the non-volatile storage (nvs), including data stored by with `microcontroller.nvm`

   This is necessary when upgrading from CircuitPython 6.3.0 or earlier to CircuitPython 7.0.0, because the
   layout of data in nvs has changed. The old data will be lost when you perform this operation.


.. py:exception:: MemoryError

   Bases: :py:obj:`MemoryError`

   Raised when an ESP IDF memory allocation fails.

   Initialize self.  See help(type(self)) for accurate signature.