host_api_sysinfo.cpp File Reference

Firmware identity / feature flags. Plugins use these to gate on the runtime they are loaded into - e.g. show a different UI for debug builds, or refuse to run on incompatible firmware revisions. More...

#include "plugin_manager/host_api.h"
#include "cdc_core/feature_flags.h"
#include "cdc_core/CpuStats.h"
#include "esp_timer.h"
#include <cstdio>
#include <cstring>

Go to the source code of this file.

Macros
#define	APP_NAME   "CDCBos"
#define	APP_VERSION   "unknown"

Functions
int	host_get_firmware_version (char *out, size_t out_size)
	Copy the firmware semver string into out.
int	host_get_build_profile (char *out, size_t out_size)
	Copy the build profile name (e.g. "release", "debug") into out.
bool	host_feature_enabled (uint16_t feature_id)
	True when the firmware was built with the given feature id enabled.
uint8_t	host_cpu_load (void)
	Aggregate CPU load across all cores as 0..100 percent. Sampled on demand from FreeRTOS run-time stats and refreshed at most a few times per second; intermediate calls return the cached value. The first call after load returns 0 (no baseline yet).

Detailed Description

Firmware identity / feature flags. Plugins use these to gate on the runtime they are loaded into - e.g. show a different UI for debug builds, or refuse to run on incompatible firmware revisions.

Definition in file host_api_sysinfo.cpp.

Macro Definition Documentation

APP_NAME

#define APP_NAME   "CDCBos"

Definition at line 18 of file host_api_sysinfo.cpp.

Referenced by host_get_firmware_version().

APP_VERSION

#define APP_VERSION   "unknown"

Definition at line 21 of file host_api_sysinfo.cpp.

Referenced by cdc::os_ui::BackupManager::exportTo(), host_get_firmware_version(), and initCoreServices().