From df32f479429cb4cd9bddd2a31008a2c0e5e21d2c Mon Sep 17 00:00:00 2001 From: Jakub <106778416+MarekZegare4@users.noreply.github.com> Date: Fri, 29 May 2026 11:26:37 +0200 Subject: [PATCH] =?UTF-8?q?docs:=20add=20settings=5Fscreen.md=20=E2=80=94?= =?UTF-8?q?=20full=20options=20with=20tables=20and=20e-ink=20notes?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Tables for all seven sections (Display, Sound, Home Pages, Radio, System, Contacts, Messages) with values, LEFT/RIGHT vs Enter interaction, and e-ink-only flags. Notes: buzzer Auto mode, battery % anchor from low_batt, Melody 1/2 link to Ringtone Editor, placeholder support in quick replies. --- .../settings_screen/settings_screen.md | 90 +++++++++++++++++++ 1 file changed, 90 insertions(+) create mode 100644 docs/plus_features/settings_screen/settings_screen.md diff --git a/docs/plus_features/settings_screen/settings_screen.md b/docs/plus_features/settings_screen/settings_screen.md new file mode 100644 index 00000000..581bfb1c --- /dev/null +++ b/docs/plus_features/settings_screen/settings_screen.md @@ -0,0 +1,90 @@ +## Settings Screen +[Go back](../../../README.md) + +### Overview + +| OLED | E-Ink | +|:----:|:-----:| +| ![](./settings_1_oled.png) | ![](./settings_1_eink.png) | + +All settings are saved to flash and restored on next boot. Settings are organised into collapsible sections. Press **Enter** on a section header to expand or collapse it — all sections start collapsed for faster navigation. Press **LEFT/RIGHT** to change a value, or **Enter** for toggle items. + +Press **Cancel/Back** to save and return to the home screen. + +--- + +### Display + +| Setting | Options | Notes | +|---------|---------|-------| +| Brightness | 1–5 | LEFT/RIGHT; preview applies immediately | +| Auto-off | 5 s / 15 s / 30 s / 60 s / never | LEFT/RIGHT | +| Auto-lock | on / off | Locks device when display turns off | +| Battery | icon / % / V | Display mode for the top-bar battery indicator | +| Clock seconds | show / hide | Hiding reduces OLED refresh from 1 s to 60 s | +| Clock format | 24 h / 12 h | 12 h appends AM/PM | +| Font | Default / Lemon | Default: 5×7 Adafruit with ASCII transliteration; Lemon: native Unicode with pixel-accurate line wrap | +| Display rotation *(e-ink only)* | 0° / 90° / 180° / 270° | Applied immediately | +| Joystick rotation *(e-ink only)* | 0° / 90° / 180° / 270° | Rotates input mapping independently of display rotation; useful for custom enclosures | +| Full refresh interval *(e-ink only)* | off / 5 / 10 / 20 / 30 | Partial refreshes between full clears; reduces ghosting on long sessions | + +--- + +### Sound + +| Setting | Options | Notes | +|---------|---------|-------| +| Buzzer | On / Off / Auto | Auto: silences while BLE connected, re-enables on disconnect | +| Volume | 1–5 | LEFT/RIGHT; preview tone plays on each change | +| DM Melody | built-in / Melody 1 / Melody 2 | Notification sound for incoming private messages | +| Channel Melody | built-in / Melody 1 / Melody 2 | Notification sound for incoming channel messages | + +Melody 1 and Melody 2 are custom sequences editable in **Tools › Ringtone Editor**. + +--- + +### Home Pages + +| OLED | E-Ink | +|:----:|:-----:| +| ![](./settings_2_oled.png) | ![](./settings_2_eink.png) | + +Lists all available home screen pages. For each entry: + +- **LEFT / RIGHT** — move the page earlier or later in the navigation sequence +- **Enter** — toggle the page ON / OFF + +**Settings** and **Messages** are always visible and cannot be disabled. + +--- + +### Radio + +| Setting | Options | Notes | +|---------|---------|-------| +| TX power | 2–22 dBm | LEFT/RIGHT | + +--- + +### System + +| Setting | Options | Notes | +|---------|---------|-------| +| Timezone | −12 h … +14 h | UTC offset in whole hours | +| Low battery | off / 3.0 V / 3.1 V / 3.2 V / 3.3 V / 3.4 V / 3.5 V | Auto-shutdown threshold; also sets the 0 % anchor for the battery percentage indicator | + +--- + +### Contacts + +| Setting | Options | Notes | +|---------|---------|-------| +| DMs | all / favourites | Show all chat contacts or only upstream-starred ones | +| Channels | all / favourites | Show all channels or only favourited ones | +| Rooms | all / favourites | Show all room servers or only favourited ones | + +--- + +### Messages + +Up to 10 quick reply templates (Q1–Q10). Press **Enter** on a slot to open the keyboard editor. Supports the same placeholders as the main keyboard (`{time}`, `{loc}`, and sensor placeholders when connected).