openmrn_arduino::Esp32CoreDumpUtil Class Reference

Utility class containing methods related to esp32 core dumps. More...

#include <Esp32CoreDumpUtil.hxx>

Static Public Member Functions
static bool	is_present ()
	Utility method to check if a core dump is present.
static void	display (const char *output_path=nullptr)
	Utility method that displays a core dump (if present).
static void	cleanup ()
	Utility method to cleanup a core dump.

Detailed Description

Utility class containing methods related to esp32 core dumps.

Usage of this class requires the enablement of CONFIG_ESP32_ENABLE_COREDUMP_TO_FLASH in sdkconfig AND the creation of a 64kb "coredump" partition in flash.

When the CONFIG_ESP32_ENABLE_COREDUMP_TO_FLASH flag is not enabled all methods in this class are treated as no-op.

NOTE: ESP-IDF v4.4 or later is required for the display() method.

Definition at line 60 of file Esp32CoreDumpUtil.hxx.

Member Function Documentation

cleanup()

static void openmrn_arduino::Esp32CoreDumpUtil::cleanup ( )

inlinestatic

Utility method to cleanup a core dump.

Definition at line 136 of file Esp32CoreDumpUtil.hxx.

display()

static void openmrn_arduino::Esp32CoreDumpUtil::display ( const char *  output_path = nullptr )

inlinestatic

Utility method that displays a core dump (if present).

Parameters

output_path

Optional output path to store the code dump on the filesystem.

Definition at line 77 of file Esp32CoreDumpUtil.hxx.

is_present()

static bool openmrn_arduino::Esp32CoreDumpUtil::is_present ( )

inlinestatic

Utility method to check if a core dump is present.

Returns

true if a core dump is available, false otherwise.

Definition at line 65 of file Esp32CoreDumpUtil.hxx.

---

The documentation for this class was generated from the following file:

• Esp32CoreDumpUtil.hxx