API Reference

[中文]

This page collects the API reference generated from the System Super public headers.

System

Public header: #include "brookesia/system_super/system.hpp"

Header File

system/brookesia_system_super/include/brookesia/system_super/system.hpp

Classes

class System : public esp_brookesia::system::core::System 

User-facing Brookesia system implementation with the built-in shell experience.

Super extends system core with launcher, notification, quick control, keyboard, loading, dialog, theme, and language handling suitable for end-user products.

Public Functions

std::expected<void, std::string> init()

Initialize the system with default Super configuration.

Returns: Empty result on success, or an error string.

std::expected<void, std::string> init(Config config)

Initialize the system with explicit Super configuration.

Parameters: config -- Super system configuration.
Returns: Empty result on success, or an error string.

struct Config

Configuration used to initialize the Super system.

Public Members

core::System::Config core_config: Core system configuration forwarded to the base system implementation.