espressif/brookesia_app_settings

0.8.5

Latest
uploaded 5 hours ago
ESP-Brookesia C++ settings app for the system-core app contract.

Readme

# ESP-Brookesia Settings App

* [中文版本](./README_CN.md)

## Overview

`brookesia_app_settings` is the built-in native settings app for System Core and System Super products.

## Supported interfaces

Settings keeps the same application identity and device service preferences across both GUI backends.

| Interface | Available pages |
| --- | --- |
| JSON / LVGL | Settings screens, including Wi-Fi connection setup |
| GSP | Home, My device, brightness, Wi-Fi, sound, language, theme, and time zone on a 1024 × 600 display |

The GSP Wi-Fi page supports turning Wi-Fi on or off, scanning, refreshing, and browsing nearby networks. Each network shows its signal strength and security status. The page also reports the current connection and handles scanning, empty results, and service errors.

Network names support common simplified and traditional Chinese, accented Latin, Greek, and Cyrillic characters.

Tap a network to connect. For a personal network that requires a password, choose **Edit password**, enter the password, confirm, and choose **Connect**. Passwords are masked. Open networks and networks with saved credentials connect directly. Connection status comes from the Wi-Fi service, which also saves successful connections and handles reconnection.

Choose **Saved networks**, select the named network, then choose **Forget** to remove its saved credentials. Forgetting the current network also disconnects it. **Nearby networks** returns to scan results. No network is selected for removal by default.

Password input uses the System Core keyboard and supports printable ASCII characters. Enterprise network configuration and Chinese input are not available.

## Sound and appearance

**Sound** controls playback volume (0–100) and mute through AudioPlayback. The service saves these settings and restores them at startup. When the host provides a test clip, **Test sound** plays it at the current volume without changing mute. Unavailable controls and failed updates are shown on the page.

GSP supports **English** and **Simplified Chinese**, including Wi-Fi status messages and keyboard controls, and **Light** and **Dark** themes across its pages. To change language or theme, select an option and choose **Restart now** or **Later**. The current interface stays active until restart; pending selections remain visible when Settings is reopened.

When the host configures GSP display and touch devices, System Core restores the appearance preferences and provides the system home, keyboard, and message dialogs. **My device** displays OS and board information, hardware capabilities, and current network status. **Time zone** offers common time zones and refreshes the SNTP state while visible. Advanced diagnostics remain in the JSON/LVGL interface.

For a complete application with a launcher and hardware setup, see the [System GSP App example](../../examples/system/gsp_app/README.md).

For more information, see the [ESP-Brookesia Programming Guide](https://docs.espressif.com/projects/esp-brookesia/en/latest/app/settings.html).

## How to Use

### Environment Requirements

Please refer to the following documentation:

- [ESP-Brookesia Programming Guide - Versioning](https://docs.espressif.com/projects/esp-brookesia/en/latest/getting_started.html#getting-started-versioning)
- [ESP-Brookesia Programming Guide - Development Environment Setup](https://docs.espressif.com/projects/esp-brookesia/en/latest/getting_started.html#getting-started-dev-environment)

### Add to Your Project

Please refer to [ESP-Brookesia Programming Guide - How to Obtain and Use Components](https://docs.espressif.com/projects/esp-brookesia/en/latest/getting_started.html#getting-started-component-usage).

Links

Supports all targets

To add this component to your project, run:

idf.py add-dependency "espressif/brookesia_app_settings^0.8.5"

download archive

Stats

  • Archive size
    Archive size ~ 896.15 KB
  • Downloaded in total
    Downloaded in total 301 times
  • Weekly Downloads Weekly Downloads (All Versions)
  • Downloaded this version
    This version: 0 times

Badge

espressif/brookesia_app_settings version: 0.8.5
|