System monitor : themes

Create/edit a theme

The System Monitor (main.py) uses themes to display your computer HW sensors & metrics.
Themes are located in res/themes, each in a sub-folder.
A theme folder contains a theme.yaml and optionally some pictures like a background picture, logos etc. It can be easily shared with the community: just share the theme sub-foler.
The theme used at startup is specified in config.yaml at repository root.

Create a new theme

When developing a new theme, do not start from existing themes as they do not contain all the sensors that can be displayed.
Instead, create a new sub-folder for your theme and copy theme_example.yaml into it as theme.yaml.
Then copy your PNG resources in your new sub-folder.
To edit your theme, use the Theme Editor (see below).

Import a theme from Turing / Xuanfang Windows app

If you have a theme you like from the original vendor app, you cannot import it directly to this program because the formats do not match. You can still extract the resources (PNGs) from the original theme using tools/turing-theme-extractor.py

python3 turing-theme-extractor.py "Dragon Ball.data"

The PNGs from the theme will be extracted to files.
The first PNG is generally the background image/color and the 2nd PNG is the layers above. You can use an online tool to "merge PNG" to get a single file that you will use as background.png for your theme. You can then re-create the theme for the System Monitor program by replacing content at the right place on top of the extracted background: see below.

Note: the default Turing/XuanFang themes resources have already been extracted to res/themes/--Theme examples/.
Check also for existing themes in res/themes/: see sub-folders. Some Turing default theme have already been fully re-created.

Open Theme Editor

The Theme Editor allow to quickly develop/update a theme without the need to restart Turing Smart Screen to reload changes.
It can be started from the configuration wizard (configure.py): select a theme and click Edit theme.
It can also be started from the command line:

Usage :
        python3 theme-editor.py theme-name (= name of the folder in res/themes/)
Examples : 
        python3 theme-editor.py 3.5inchTheme2
        python3 theme-editor.py Landscape6Grid
        python3 theme-editor.py Cyberpunk

When started, the program will open the selected theme YAML file in your default editor for .yaml files (e.g. Notepad++, VS Code...)
It will also open an always-on-top window displaying a preview of the selected theme with stubbed data (not your real computer HW sensors).

Whenever you edit and save the theme.yaml file from your editor, the preview window will reload the theme with your new changes.
If the theme file does not open automatically, you can open it manually in the editor of your choice.

You can now edit your theme file following the next section:

theme.yaml

The mandatory theme.yaml file defines what to show on the screen and where to show it.
The file is structured in several entries.
Some theme files may not contain all entries if they do not use them.
For an exemple, see theme_example.yaml file that contains all metrics in it.

`author` entry

The author entry defines theme author name as a string:

author: "John Doe"

This name will be displayed below the theme preview in the Configuration Wizard.
If the author name starts with @ it will be displayed as a hyperlink to the author's GitHub profile.

author: "@johndoe"

This entry is not mandatory.

`display` entry

The display entry defines the display specific configuration for this theme:

orientation
backplate RGB LEDs colors for supported HW

This entry and its properties are mandatory.

display:
  # Specify the display size in inch for this theme: 3.5" (default) or 5"
  DISPLAY_SIZE: 3.5"

  # Specify the display orientation for this theme: portrait, landscape, reverse_portrait, reverse_landscape
  DISPLAY_ORIENTATION: portrait

  # Backplate RGB LED color (for HW revision 'flagship' devices only), set one that match your theme dominant color
  DISPLAY_RGB_LED: 0, 0, 255

`static_images` entry

The static_images entry defines some pictures to be displayed once at boot, like a background picture.
Entries in static_images must have unique names.

Classic images formats are supported: jpg, png, etc. Run python3 -m PIL to get all supported formats.
Images are fetch from the theme sub-folder.
They are drawn in the order they are listed, the top image will be drawn first.

static_images:
  MY_THEME_BACKGROUND:
    PATH: background.png
    X: 0
    Y: 0
    WIDTH: 320
    HEIGHT: 480
  MY_CUSTOM_LOGO:
    PATH: logo1.jpg
    X: 150
    Y: 100
    WIDTH: 50
    HEIGHT: 50

`static_text` entry

The static_text entry defines some text to be displayed once at boot, like labels.
Entries in static_text must have unique names.

Texts are drawn in the order they are listed, the top text will be drawn first.
You can specify a font .ttf filename (fetched from res/fonts/ folder) as well as a font size and font color. For text to have a transparent background, you must provide the path to the image you used as background picture in BACKGROUND_IMAGE instead.

static_images:
  DISK_USED_LABEL:
    TEXT: "Used:"
    X: 124
    Y: 405
    FONT: jetbrains-mono/JetBrainsMono-Bold.ttf
    FONT_SIZE: 23
    FONT_COLOR: 255, 255, 255
    BACKGROUND_COLOR: 132, 154, 165
    # BACKGROUND_IMAGE: background.png
    ALIGN: left
    ANCHOR: lt
  TRANSPARENT_TEXT:
    TEXT: "MyText"
    X: 200
    Y: 200
    FONT: geforce/GeForce-Bold.ttf
    FONT_SIZE: 23
    FONT_COLOR: 255, 255, 255
    # BACKGROUND_COLOR: 132, 154, 165
    BACKGROUND_IMAGE: background.png
    ALIGN: right
    ANCHOR: lt

`STATS` entry

The STATS entry defines the computer HW sensors & metrics that are displayed on screen by the theme.

Available hardware sensors & metrics

CPU:
- usage (%)
- frequency (GHz)
- average loads in the latest 1/5/15 minutes (%)
- temperature (°C)
- fan speed (RPM)
GPU:
- usage (%)
- GPU memory usage (% and Mb)
- temperature (°C)
- FPS
- fan speed (RPM)
- frequency (GHz)
MEMORY:
- Swap usage (%)
- (virtual) usage (% and Mb)
DISK:
- usage (% and Gb)
- total size (Gb)
- free space (Gb)
NETWORK:
- for the two network interfaces (WLO and ETH):
  - upload/download speed (automatic unit : B/s, M/s...)
  - uploaded/downloaded data (automatic unit: B, M, G...)
DATE/TIME

Some files may not have all metrics if the theme does not use it. For an exemple, see theme_example.yaml file that contains all metrics in it.

Refresh rate

Every metric has an INTERVAL parameter in seconds between two redraw of the value.
Longer intervals lower CPU usage, but cause data to be refreshed more slowly on screen.
Small values will display near real time data on screen, but may cause significant CPU usage or fill the asynchronous request queue if requests are added faster than they are processed by display.

Graphical components

Sensors can be displayed using several components:

TEXT: a label to display current value as text with its unit

GRAPH: an horizontal bar graph to display current value on a min/max scale

RADIAL: a radial bar graph to display current value on a min/max scale, and text value in the center

LINE_GRAPH: a line graph to display current and previous values

`GRAPH` metrics

GRAPH metrics are displayed as horizontal progress bars.
Customization options:

BAR_COLOR RGB color for the filled part of the bar.
BACKGROUND_COLOR RGB color for the empty part of the bar. For progress bars to have a transparent background, you must provide the path to the image you used as background picture in BACKGROUND_IMAGE instead.
BAR_OUTLINE Whether to show outline or not. The outline will have the same color as the bar.
MIN_VALUE and MAX_VALUE must generally not be edited, they are set to [0,100] because they display usages values (%).

  DISK:
    USED:
      GRAPH:
        SHOW: True
        X: 155
        Y: 345
        WIDTH: 150
        HEIGHT: 15
        MIN_VALUE: 0
        MAX_VALUE: 100
        BAR_COLOR: 0, 0, 255
        BAR_OUTLINE: False
        BACKGROUND_COLOR: 0, 0, 0
        # BACKGROUND_IMAGE: background.png

`TEXT` metrics

TEXT metrics are displayed as horizontal texts.
Customization options:

FONT font .ttf filename (fetched from res/fonts/ folder).
BACKGROUND_COLOR RGB color for the empty part of the bar. For progress bars to have a transparent background, you must provide the path to the image you used as background picture in BACKGROUND_IMAGE instead.

⚠ Use a monospace font, otherwise text size may vary and cause old values to not be erased properly by new values

  CPU:
    PERCENTAGE:
      TEXT:
        SHOW: True
        X: 250
        Y: 13
        FONT: jetbrains-mono/JetBrainsMono-Bold.ttf
        FONT_SIZE: 23
        FONT_COLOR: 255, 255, 255
        BACKGROUND_COLOR: 132, 154, 165
        # BACKGROUND_IMAGE: background.png

Add `CUSTOM` stats to a theme

While this projects aims to include most used hardware sensor stats available for theming, you may want to add your own custom data (unsupported hardware sensors, sound from music players, web API data...) and display them on themes next to other sensors.

This is possible and is made in 2 steps: first you need to develop your Python code to gather your custom data to display, then you need to specify in your theme how and where to display these custom data.

Write Python code to get custom data

A Python custom data class must be implemented in library/sensors/sensors_custom.py, inherit the CustomDataSource abstract class and implement its 2 methods as_numeric()and as_string().

Your class can offer numeric and/or string data:

Numeric value from as_numeric() function will be used for graph and radial progress bars. If there is no numeric value to return, keep as_numeric() empty, but it won't be possible to display graph or radial bars on a theme from this class.
Text value from as_string() function will be used for text display and radial progress bar inner text. If as_string() function is empty, the numeric value from as_numeric() will be used as string without formatting.

You will find in library/sensors/sensors_custom.py two examples already implemented with comments to help you get started:

class ExampleCustomNumericData is a custom data class that returns a numeric value, and a string which contains the same numeric value but formatted with a unit.
class ExampleCustomTextOnlyData is a custom data class that that only has text values. This class can display only text on themes, it won't be possible to display graph or radial bars.

There is no limitation on how much custom data source classes can be added.
Feel free to add as many classes as you like. They need to have a unique class name.

Display custom data on a theme

To display these custom data sources to a theme, they must be added to a new CUSTOM: field in the STATS:section from the theme.yaml file of the theme. The name of the class in theme.yaml must be an exact match to the class name in sensors_custom.py

Here is an example for the ExampleCustomNumericData class listed previously. Because this class has numeric values, it can be displayed as text, as graph progress bar and/or as radial progress bar:

STATS:
  # All custom sensor classes are listed under CUSTOM
  CUSTOM:
    # For now the refresh interval (in seconds) is the same for all custom data classes
    INTERVAL: 3
    # The name of the class must be an exact match to the class name in sensors_custom.py
    ExampleCustomNumericData:
      # There are 3 ways of displaying a custom sensor containing numeric values: as text, as graph progress bar, as radial progress bar
      GRAPH:
        SHOW: True
        X: 50
        Y: 150
        WIDTH: 180
        HEIGHT: 30
        MIN_VALUE: 0
        MAX_VALUE: 100
        BAR_COLOR: 255, 135, 0
        BAR_OUTLINE: True
        # BACKGROUND_COLOR: 0, 0, 0
        BACKGROUND_IMAGE: background.png

A theme has been developed to match example classes from sensors_custom.py : check res/themes/CustomDataExample/theme.yaml

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

System monitor : themes

Create/edit a theme

Create a new theme

Import a theme from Turing / Xuanfang Windows app

Open Theme Editor

theme.yaml

`author` entry

`display` entry

`static_images` entry

`static_text` entry

`STATS` entry

Available hardware sensors & metrics

Refresh rate

Graphical components

`GRAPH` metrics

`TEXT` metrics

Add `CUSTOM` stats to a theme

Write Python code to get custom data

Display custom data on a theme

Clone this wiki locally

System monitor : themes

Create/edit a theme

Create a new theme

Import a theme from Turing / Xuanfang Windows app

Open Theme Editor

theme.yaml

author entry

display entry

static_images entry

static_text entry

STATS entry

Available hardware sensors & metrics

Refresh rate

Graphical components

GRAPH metrics

TEXT metrics

Add CUSTOM stats to a theme

Write Python code to get custom data

Display custom data on a theme

Clone this wiki locally

`author` entry

`display` entry

`static_images` entry

`static_text` entry

`STATS` entry

`GRAPH` metrics

`TEXT` metrics

Add `CUSTOM` stats to a theme