Skip to content

Commit 9bd4f39

Browse files
committed
Update README.md
1 parent 46dbfdf commit 9bd4f39

File tree

8 files changed

+42
-30
lines changed

8 files changed

+42
-30
lines changed

README.md

Lines changed: 42 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,5 @@
11
# turing-smart-screen-python
22

3-
| Check out new version with system monitoring features! |
4-
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
5-
| Are you using your Turing Smart Screen for system monitoring? <br>If so, check out the new [**pre-release 2.0.0 beta 1 - 📊 System Monitor**](https://github.com/mathoudebine/turing-smart-screen-python/releases/tag/2.0.0-beta.1) or the `feature/system-monitoring` branch! <br><img src="res/pics/Theme3.5Inch.jpg" height="600" /> <img src="res/pics/ThemeTerminal.jpg" height="600" /> <br>It contains embedded hardware monitoring functions, theme creation from configuration files, serial port auto-detection... <br>See Release Notes to learn more about features and current limitations <br>_Python knowledges recommended._ |
6-
7-
---
8-
93
### ⚠️ DISCLAIMER - PLEASE READ ⚠️
104

115
This project is **not affiliated, associated, authorized, endorsed by, or in any way officially connected with Turing brand**, or any of its subsidiaries, affiliates, manufacturers or sellers of the Turing products. All product and company names are the registered trademarks of their original owners.
@@ -14,42 +8,60 @@ This project is an open-source alternative software, not the USBMonitor.exe orig
148

159
---
1610

17-
A simple Python manager for "Turing Smart Screen" 3.5" IPS USB-C (UART) display, also known as :
11+
A Python system monitor program and a library for "Turing Smart Screen" 3.5" IPS USB-C (UART) display, also known as :
1812
- Turing USB35INCHIPS / USB35INCHIPSV2 (revision A)
1913
- XuanFang display (revision B & flagship)
2014
- [3.5 Inch 320*480 Mini Capacitive Touch Screen IPS Module](https://www.aliexpress.com/item/1005003723773653.html)
2115

22-
## Hardware
23-
<img src="res/pics/smart-screen-3.webp" width="500"/>
16+
<img src="res/docs/smart-screen-2.webp" height="300" />
17+
18+
[**Display hardware revisions supported: A, B & flagship**](https://github.com/mathoudebine/turing-smart-screen-python/wiki/Hardware-revisions).
19+
Flagship backplate RGB LEDs are also supported!
20+
21+
Operating systems supported : macOS, Windows, Linux (incl. Raspberry Pi) and all OS that support Python 3.x
22+
23+
24+
## How to use
2425

25-
The Turing Smart Screen is a 3.5" USB-C display that shows as a serial port once connected.
26-
It cannot be seen by the operating system as a monitor but pictures can be displayed on it.
26+
### [> Follow instructions on the wiki to configure and start this project.](https://github.com/mathoudebine/turing-smart-screen-python/wiki)
2727

28-
There is 3 hardware revisions of the screen: [how to identify my version?](https://github.com/mathoudebine/turing-smart-screen-python/wiki/Hardware-revisions) Version B and "flagship" use the same protocol.
29-
A [Windows-only software is available](https://github.com/mathoudebine/turing-smart-screen-python/wiki/Vendor-apps) is provided by the vendor to manage this display.
30-
This software allows creating themes to display your computer sensors on the screen, but does not offer a simple way to display custom pictures or text.
28+
There are 2 possible uses of this project Python code:
29+
* **[as a System Monitor](#system-monitor)**, a standalone program working with themes to display your computer HW info.
30+
* **[integrated in your project](#control-the-display-from-your-python-projects)**, to control the display from your own Python code.
3131

32-
## Features
33-
This Python script can do some simple operations on the Turing display like :
32+
## System monitor
33+
34+
This project is mainly a complete standalone program to use your screen as a system monitor, like the original vendor app.
35+
Some themes are already included for a quick start!
36+
### [> Configure and start system monitor](https://github.com/mathoudebine/turing-smart-screen-python/wiki/System-monitor-:-how-to-start)
37+
* Fully functional multi-OS code base (operates out of the box, tested on Windows, Linux & MacOS).
38+
* Display configuration using `config.yaml` file: no Python code to edit.
39+
* Support for all [3 screen HW revisions: A, B & flagship](https://github.com/mathoudebine/turing-smart-screen-python/wiki/Hardware-revisions). Flagship backplate RGB LEDs are also supported!
40+
* 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.
41+
* Allow [creation of themes (see `res/themes`) with `theme.yaml` files](https://github.com/mathoudebine/turing-smart-screen-python/wiki/System-monitor-:-themes) to be shared with the community!
42+
* Easy to expand: additional code that pulls specific information can be written in a modular way without impacting existing code.
43+
* Auto detect comm port. No longer need to hard set it, or if it changes on you then the config is wrong.
44+
45+
Screenshots from the latest version using included themes:
46+
<img src="res/docs/Theme3.5Inch.jpg" height="400" /> <img src="res/docs/ThemeTerminal.jpg" height="400" />
47+
48+
### [> Themes creation/edition](https://github.com/mathoudebine/turing-smart-screen-python/wiki/System-monitor-:-themes)
49+
50+
## Control the display from your Python projects
51+
52+
If you don't want to use your screen for system monitoring, you can just use this project as a module to do some simple operations on the display from any Python code :
3453
- **Display custom picture**
3554
- **Display text**
3655
- **Display progress bar**
3756
- **Screen rotation**
38-
- Clear the screen (blank) - HW version A only
39-
- Turn the screen on/off - HW version A only
40-
- Display soft reset - HW version A only
57+
- Clear the screen (blank)
58+
- Turn the screen on/off
59+
- Display soft reset
4160
- Set brightness
61+
- Set backplate RGB LEDs color (on supported hardware rev.)
62+
63+
Check `simple-program.py` as an example.
4264

43-
Operating systems supported : macOS, Windows, Linux (incl. Raspberry Pi) and all OS that support Python3.7
65+
### [> Control the display from your code](Control-screen-from-your-own-code)
4466

45-
## Getting started
46-
_Python knowledges recommended._
47-
Download this project by cloning it or using the [Releases sections](https://github.com/mathoudebine/turing-smart-screen-python/releases)
48-
Download and install the latest Python 3.x (min. 3.7) for your OS: https://www.python.org/downloads/
49-
Plug your Turing display to your computer (install the drivers if on Windows)
50-
[Identify your hardware revision (version A or version B/flagship)](https://github.com/mathoudebine/turing-smart-screen-python/wiki/Hardware-revisions)
51-
Open the `config.yaml` file and change display settings if needed.
52-
Open a terminal and run `python3 main.py` or `py -3 main.py` depending on your OS
53-
You should see animated content on your Turing display!
5467

55-
For a simple program to control display (e.g. from your personal Python project), you can look at `simple-program.py`

res/docs/Theme3.5Inch.jpg

1.44 MB
Loading

res/docs/ThemeTerminal.jpg

3.04 MB
Loading

res/docs/VersionA.webp

42.8 KB
Loading

res/docs/VersionFlagship.jpg

1.05 MB
Loading
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)