modm API documentation
Public Typedefs | Static Public Member Functions | List of all members
modm::platform::FaultReporter Class Reference
Platform HAL » ARM Cortex-M Fault Reporters

#include <modm/platform/fault/fault.hpp>

Public Typedefs

using const_iterator = FaultStorage::Iterator
 

Static Public Member Functions

static const_iterator begin ()
 
static const_iterator end ()
 
static bool hasReport ()
 
static std::span< const uint8_t, 20 > buildId ()
 
static void clear ()
 Clears the report.
 
static void clearAndReboot ()
 Clears the report and reboots the device.
 

Detailed Description

Public interface to accessing fault reports, providing a const_iterator for accessing the read only report.

Member Function Documentation

static std::span<const uint8_t, 20> modm::platform::FaultReporter::buildId ( )
inlinestatic
Returns
a 20-bytes SHA1 of the firmware for identification
static bool modm::platform::FaultReporter::hasReport ( )
inlinestatic
Returns
report size > 0
The documentation for this class was generated from the following files: