idfxx 1.0.0
Modern C++23 components for ESP-IDF
Loading...
Searching...
No Matches
Application Info

Accessors for the running application's embedded metadata. More...

Namespaces

namespace  idfxx
 
namespace  idfxx::app
 

Functions

std::string_view idfxx::app::version ()
 Returns the application version string.
 
std::string_view idfxx::app::project_name ()
 Returns the project name.
 
std::string_view idfxx::app::compile_time ()
 Returns the compile time string.
 
std::string_view idfxx::app::compile_date ()
 Returns the compile date string.
 
std::string_view idfxx::app::idf_version ()
 Returns the ESP-IDF version string used to build the firmware.
 
uint32_t idfxx::app::secure_version ()
 Returns the secure version counter.
 
std::string idfxx::app::elf_sha256_hex ()
 Returns the ELF SHA-256 hash as a hex string.
 

Detailed Description

Accessors for the running application's embedded metadata.

Provides information about the currently running firmware image, including version, project name, build timestamps, and ELF hash. All string accessors return views into static storage and do not allocate.

#include <idfxx/app>
auto ver = idfxx::app::version(); // e.g. "1.0.0"
auto name = idfxx::app::project_name(); // e.g. "my_project"
std::string_view project_name()
Returns the project name.
std::string_view version()
Returns the application version string.

Function Documentation

◆ compile_date()

std::string_view idfxx::app::compile_date ( )

Returns the compile date string.

Returns
The date the firmware was compiled, e.g. "Jan 1 2026".

◆ compile_time()

std::string_view idfxx::app::compile_time ( )

Returns the compile time string.

Returns
The time the firmware was compiled, e.g. "12:34:56".

◆ elf_sha256_hex()

std::string idfxx::app::elf_sha256_hex ( )

Returns the ELF SHA-256 hash as a hex string.

Returns
A hex-encoded SHA-256 string (typically 64 characters).

◆ idf_version()

std::string_view idfxx::app::idf_version ( )

Returns the ESP-IDF version string used to build the firmware.

Returns
The ESP-IDF version string.

◆ project_name()

std::string_view idfxx::app::project_name ( )

Returns the project name.

Returns
The project name embedded in the firmware image.

◆ secure_version()

uint32_t idfxx::app::secure_version ( )

Returns the secure version counter.

Returns
The secure version value embedded in the firmware image.

◆ version()

std::string_view idfxx::app::version ( )

Returns the application version string.

Returns
The version string embedded in the firmware image.