Device Helper

Public header: #include "brookesia/service_helper/system/device.hpp"

Overview

This page documents the Device helper Doxygen API: types, enums, methods, and macros. The Device helper is the standard application-layer entry point for device control and status-query interfaces backed by HAL capabilities.

API Reference

Header File

service/framework/brookesia_service_helper/include/brookesia/service_helper/system/device.hpp

Classes

class Device : public esp_brookesia::service::helper::Base<Device>

Helper schema definitions for the device control service.

Public Types

using Capabilities = hal::DeviceInfoList: Runtime capability snapshot for the device control service.

using BoardInfo = hal::system::BoardInfoIface::Info : Static board information.

using PowerBatteryInfo = hal::power::BatteryIface::Info : Static battery information.

using PowerBatteryState = hal::power::BatteryIface::State : Runtime battery state snapshot.

using PowerBatteryChargeConfig = hal::power::BatteryIface::ChargeConfig : Battery charge configuration.

using CameraDeviceInfos = std::vector<hal::video::CameraIface::DeviceInfo>: Camera device information list.

struct NetworkConnectivityInfo: Current network connectivity snapshot.