idfxx::ota::app_description Class Reference

Application description from a firmware image. More...

Public Member Functions
std::string_view	version () const
	Returns the application version string.
std::string_view	project_name () const
	Returns the project name.
std::string_view	time () const
	Returns the compile time string.
std::string_view	date () const
	Returns the compile date string.
std::string_view	idf_ver () const
	Returns the ESP-IDF version string used to build the image.
uint32_t	secure_version () const
	Returns the secure version counter.
std::span< const uint8_t, 32 >	app_elf_sha256 () const
	Returns the SHA-256 hash of the application ELF file.
const esp_app_desc_t &	idf_handle () const
	Returns a reference to the underlying ESP-IDF app description structure.

Friends
result< app_description >	try_partition_description (const partition &)
	Returns the application description from a partition.

Detailed Description

Application description from a firmware image.

Provides read-only access to metadata embedded in a firmware image, including version, project name, build time, and ELF SHA-256 hash.

Definition at line 98 of file ota.hpp.

Member Function Documentation

app_elf_sha256()

std::span< const uint8_t, 32 > idfxx::ota::app_description::app_elf_sha256

(

)

const

Returns the SHA-256 hash of the application ELF file.

date()

std::string_view idfxx::ota::app_description::date

(

)

const

Returns the compile date string.

idf_handle()

const esp_app_desc_t & idfxx::ota::app_description::idf_handle ( ) const

inline

Returns a reference to the underlying ESP-IDF app description structure.

Definition at line 122 of file ota.hpp.

idf_ver()

std::string_view idfxx::ota::app_description::idf_ver

(

)

const

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

project_name()

std::string_view idfxx::ota::app_description::project_name

(

)

const

Returns the project name.

secure_version()

uint32_t idfxx::ota::app_description::secure_version

(

)

const

Returns the secure version counter.

time()

std::string_view idfxx::ota::app_description::time

(

)

const

Returns the compile time string.

version()

std::string_view idfxx::ota::app_description::version

(

)

const

Returns the application version string.

Friends And Related Symbol Documentation

try_partition_description

result< app_description > try_partition_description ( const partition &  )

friend

Returns the application description from a partition.

Parameters

part	An application partition to read from.

Returns

The app description, or an error.

Return values

idfxx::errc::not_found

if the partition does not contain a valid app descriptor.

---

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

• idfxx_ota/include/idfxx/ota.hpp