开发板信息接口

[English]

公共头文件: #include "brookesia/hal_interface/interfaces/general/board_info.hpp"

类名: BoardInfoIface

BoardInfoIface 用于暴露开发板静态元信息,例如开发板名称、主控芯片、硬件版本、描述和制造商。上层可以通过该接口在运行时识别当前板型,并据此展示设备信息或选择板级相关逻辑。

API 参考

Header File

Classes

class BoardInfoIface : public esp_brookesia::hal::Interface

Board information interface for querying static board metadata.

Public Functions

inline explicit BoardInfoIface(Info info)

Construct a board information interface.

参数

info -- [in] Static board information.

virtual ~BoardInfoIface() = default

Virtual destructor for polymorphic board information interfaces.

inline const Info &get_info() const

Get static board information.

返回

Board information.

Public Static Attributes

static constexpr const char *NAME = "BoardInfo"

Interface registry name.

struct Info

Static board information.

Public Functions

inline bool is_valid() const

Check whether the board information contains useful identity fields.

返回

true if either board name or chip is non-empty; otherwise false.

Public Members

std::string name

Board name.

std::string chip

Main chip model.

std::string version

Board hardware or BOM version.

std::string description

Human-readable board description.

std::string manufacturer

Board manufacturer.