Skip to content

Commit 45f9870

Browse files
committed
Update README
1 parent b0a7132 commit 45f9870

2 files changed

Lines changed: 21 additions & 22 deletions

File tree

README.md

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,35 @@
11
# ![Icon](https://raw.githubusercontent.com/mathoudebine/turing-smart-screen-python/main/res/icons/monitor-icon-17865/24.png) turing-smart-screen-python
22

3-
### ⚠️ DISCLAIMER - PLEASE READ ⚠️
4-
5-
This project is **not affiliated, associated, authorized, endorsed by, or in any way officially connected with Turing / XuanFang / Kipye brands**, or any of theirs subsidiaries, affiliates, manufacturers or sellers of their products. All product and company names are the registered trademarks of their original owners.
6-
7-
This project is an open-source alternative software, NOT the original software provided for the smart screens. **Please do not open issues for USBMonitor.exe/ExtendScreen.exe or for the smart screens hardware here**.
8-
* for Turing Smart Screen, use the official forum here: http://discuz.turzx.com/
9-
* for other smart screens, contact your reseller
10-
---
3+
> [!WARNING]
4+
>
5+
> This project is **not affiliated, associated, authorized, endorsed by, or in any way officially connected with Turing / XuanFang / Kipye brands**, or any of theirs subsidiaries, affiliates, manufacturers or sellers of their products. All product and company names are the registered trademarks of their original owners.
6+
>
7+
> This project is an open-source alternative software, NOT the original software provided for the smart screens. **Please do not open issues for USBMonitor.exe/ExtendScreen.exe or for the smart screens hardware here**.
8+
> * for Turing Smart Screen, use the official forum here: http://discuz.turzx.com/
9+
> * for other smart screens, contact your reseller
1110
1211
![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)
1312

14-
A Python system monitor program and an abstraction library for **small IPS USB-C (UART) displays.**
13+
A Python system monitor program and an abstraction library for **small IPS USB-C displays.**
1514

1615
Supported operating systems : macOS, Windows, Linux (incl. Raspberry Pi), basically all OS that support Python 3.9+
1716

1817
### ✅ Supported smart screens models:
1918

20-
| ✅ Turing Smart Screen 3.5" |XuanFang 3.5" | ✅ Turing Smart Screen 5" |
21-
|------------------------------------------------------|---------------------------------------------------|---------------------------------------------|
22-
| <img src="res/docs/turing.webp"/> | <img src="res/docs/xuanfang.webp"/> | <img src="res/docs/turing5inch.png"/> |
23-
| also improperly called "revision A" by the resellers | revision B & flagship (with backplate & RGB LEDs) | basic support (no video or storage for now) |
19+
| ✅ Turing Smart Screen 3.5" |Turing / TURZX 4.6" | ✅ Turing / TURZX 5" / 5.2" |
20+
|------------------------------------------------------|---------------------------------------------|---------------------------------------------|
21+
| <img src="res/docs/turing.webp"/> | <img src="res/docs/turing46inch.png"/> | <img src="res/docs/turing5inch.png"/> |
22+
| also improperly called "revision A" by the resellers | basic support (no video or storage for now) | basic support (no video or storage for now) |
2423

25-
| ⚠️ Turing Smart Screen 8.8" | ✅ Turing Smart Screen 2.1" / 2.8" |
26-
|---------------------------------------------|------------------------------------------------------------------|
27-
| <img src="res/docs/turing8inch.webp"/> | <img src="res/docs/turing2inch.webp" width="60%" height="60%"/> |
28-
| basic support (no video or storage for now)<br/>⚠️ [New revision V1.1 not supported!](https://github.com/mathoudebine/turing-smart-screen-python/issues/727) | basic support (no video or storage for now) |
24+
| Turing / TURZX 2.1" / 2.8" | ✅ Turing / TURZX 8.0" | ✅ Turing / TURZX 8.8" / 9.2" |
25+
|---------------------------------------------|---------------------------------------------|---------------------------------------------|
26+
| <img src="res/docs/turing2inch.webp"/> | <img src="res/docs/turing8inch.png"/> | <img src="res/docs/turing8inch.webp"/> |
27+
| basic support (no video or storage for now) | basic support (no video or storage for now) | basic support (no video or storage for now) |
2928

30-
|[UsbPCMonitor 3.5" / 5"](https://aliexpress.com/item/1005003931363455.html) |[Kipye Qiye Smart Display 3.5"](https://www.aliexpress.us/item/3256803899049957.html) |
31-
|-----------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------|
32-
| <img src="res/docs/UsbPCMonitor_5inch.webp" width="60%" height="60%"/> | <img src="res/docs/kipye-qiye-35.webp" width="60%" height="60%"/> |
33-
| Unknown manufacturer, visually similar to Turing 3.5" / 5". Original software is `UsbPCMonitor.exe` | Front panel has an engraved inscription "奇叶智显" Qiye Zhixian (Qiye Smart Display) |
29+
|XuanFang 3.5" |[UsbPCMonitor 3.5" / 5"](https://aliexpress.com/item/1005003931363455.html) |[Kipye Qiye Smart Display 3.5"](https://www.aliexpress.us/item/3256803899049957.html) |
30+
|---------------------------------------------------|-----------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------|
31+
| <img src="res/docs/xuanfang.webp"/> | <img src="res/docs/UsbPCMonitor_5inch.webp" width="60%" height="60%"/> | <img src="res/docs/kipye-qiye-35.webp" width="60%" height="60%"/> |
32+
| revision B & flagship (with backplate & RGB LEDs) | Unknown manufacturer, visually similar to Turing 3.5" / 5". Original software is `UsbPCMonitor.exe` | Front panel has an engraved inscription "奇叶智显" Qiye Zhixian (Qiye Smart Display) |
3433

3534
| ✅ WeAct Studio Display FS V1 0.96" | ✅ WeAct Studio Display FS V1 3.5" |
3635
|---------------------------------------------------------------|--------------------------------------------------------------|
@@ -87,7 +86,7 @@ Some themes are already included for a quick start!
8786

8887
* Fully functional multi-OS code base (operates out of the box, tested on Windows, Linux & MacOS).
8988
* Display configuration using GUI configuration wizard or `config.yaml` file: no Python code to edit.
90-
* Compatible with [3.5" & 5" smart screen models (Turing, XuanFang...)](https://github.com/mathoudebine/turing-smart-screen-python/wiki/Hardware-revisions). Backplate RGB LEDs are also supported for available models!
89+
* Compatible with [multiple smart screen models (Turing, XuanFang...)](https://github.com/mathoudebine/turing-smart-screen-python/wiki/Hardware-revisions). Backplate RGB LEDs are also supported for available models!
9190
* Support [multiple hardware sensors and metrics (CPU/GPU usage, temperatures, memory, disks, etc)](https://github.com/mathoudebine/turing-smart-screen-python/wiki/System-monitor-:-themes#stats-entry) with configurable refresh intervals.
9291
* Allow [creation of themes (see `res/themes`) with `theme.yaml` files using theme editor](https://github.com/mathoudebine/turing-smart-screen-python/wiki/System-monitor-:-themes) to be [shared with the community!](https://github.com/mathoudebine/turing-smart-screen-python/discussions/categories/themes)
9392
* Easy to expand: [custom Python data sources](https://github.com/mathoudebine/turing-smart-screen-python/wiki/System-monitor-:-themes#add-custom-stats-to-a-theme) can be written to pull specific information and display it on themes like any other sensor.

res/docs/turing5inch.png

141 KB
Loading

0 commit comments

Comments
 (0)