Skip to content

Commit 815d8ed

Browse files
Fumunchuclaude
andcommitted
README: add fork banner describing the display platform additions
Single delimited block at the top linking DISPLAY.md and issue mathoudebine#1011; the rest of the README stays untouched upstream content to keep future merges trivial. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent ad3ec32 commit 815d8ed

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,26 @@
88
> * for Turing Smart Screen, use the official forum here: http://discuz.turzx.com/
99
> * for other smart screens, contact your reseller
1010
11+
> [!NOTE]
12+
> ## 🔀 About this fork: display platform (carousel / netmap / YAML pages)
13+
> This fork adds a **multi-page display platform** on top of the stock project — everything is
14+
> **purely additive** (no upstream files modified) and documented in **[DISPLAY.md](DISPLAY.md)**:
15+
> * 🎠 **Page carousel** — rotate YAML-defined stat pages (live-reloaded, per-page dwell/refresh)
16+
> ***Diff-based partial rendering** — only changed bands cross the serial link; in-page value
17+
> ticks are wipe-free and CPU/RAM stays tiny (~1% of one core, ~30 MB)
18+
> * 🗺️ **Animated network map** — hosts up/down as a star topology, packet dots on spokes with live traffic
19+
> * 📊 **Widgets**: `bar`, `metric`, `radial` (traces existing theme ring art — works great over the
20+
> stock *Cyberdeck* background), `text`, `graph` (multi-series history), `cores` (per-core mini-bars)
21+
> * 🔌 **Pluggable data sources** — local psutil values plus named sources (Prometheus implemented),
22+
> so pages can show Kubernetes, fleet, or any scraped metric next to host stats
23+
> * 🌙 Extras: backlight night/away schedule, serial auto-reconnect, net rates with auto units,
24+
> RAPL CPU watts, systemd unit
25+
>
26+
> Quick start: `venv/bin/python display.py` with `display.yaml` (`mode: standard` runs the stock
27+
> engine untouched). Proposed upstream in
28+
> [mathoudebine/turing-smart-screen-python#1011](https://github.com/mathoudebine/turing-smart-screen-python/issues/1011).
29+
> Everything below this block is the original upstream README.
30+
1131
![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black) ![Windows](https://img.shields.io/badge/Windows%2010%2F11-0078D6?style=for-the-badge&logoColor=white&logo=data:image/svg%2bxml;base64,PHN2ZyByb2xlPSJpbWciIHZpZXdCb3g9IjAgMCAyNCAyNCIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48dGl0bGU+V2luZG93czwvdGl0bGU+PHBhdGggZmlsbCA9ICIjRkZGRkZGIiBkPSJNMCwwSDExLjM3N1YxMS4zNzJIMFpNMTIuNjIzLDBIMjRWMTEuMzcySDEyLjYyM1pNMCwxMi42MjNIMTEuMzc3VjI0SDBabTEyLjYyMywwSDI0VjI0SDEyLjYyMyIvPjwvc3ZnPg==) [![macOS](https://img.shields.io/badge/mac%20os%20(⚠️major%20bug)-000000?style=for-the-badge&logo=apple&logoColor=white)](https://github.com/mathoudebine/turing-smart-screen-python/issues/7) ![Raspberry Pi](https://img.shields.io/badge/Raspberry%20Pi-A22846?style=for-the-badge&logo=Raspberry%20Pi&logoColor=white) ![Python](https://img.shields.io/badge/Python-3.X-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54) [![Licence](https://img.shields.io/github/license/mathoudebine/turing-smart-screen-python?style=for-the-badge)](./LICENSE)
1232

1333
A Python system monitor program and an abstraction library for **small IPS USB-C displays.**

0 commit comments

Comments
 (0)