Skip to content

Commit

Permalink
Merge pull request #26 from razman786/development
Browse files Browse the repository at this point in the history 
Version 0.8.3:
* Closes #25 
* Dependencies have been decoupled
* Console now provides some debug information by default
* New installation script options
* Added Manjaro Linux polkit action files
* Updated README
* Various bug fixes
  • Loading branch information
@razman786
razman786 committed Jun 8, 2023
2 parents c2d5559 + 44cca37 commit a1ab8ed
Show file tree
Hide file tree
Showing 9 changed files with 1,371 additions and 521 deletions.
124 changes: 91 additions & 33 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
# I8kGUI
# I8KGUI

![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/razman786/i8kgui/installation.yml?branch=master) ![GitHub release (latest by date)](https://img.shields.io/github/v/release/razman786/i8kgui)

## Introduction

A Dell thermal management GUI to control fan speeds and monitor temperatures. Information is taken from [i8kutils](https://github.com/vitorafsr/i8kutils), Sysfs and [(SM)BIOS](https://github.com/dell/libsmbios) - created as a quick hack for my own needs (screenshots may be of an older version).
A Dell thermal management GUI to control fan speeds and monitor temperatures.
Information is taken from
[dell-smm-hwmon](https://www.kernel.org/doc/html/latest/hwmon/dell-smm-hwmon.html),
[i8kutils](https://github.com/vitorafsr/i8kutils), Sysfs and
[(SM)BIOS](https://github.com/dell/libsmbios) - created as a quick hack for my
own needs (screenshots may be of an older version).

<p align="center">
<img src="https://user-images.githubusercontent.com/7116312/230130936-98105ddc-edcb-4499-b1a0-7c0b9337c1f4.png" alt="i8k" width="150" />
Expand All @@ -15,55 +20,85 @@ A Dell thermal management GUI to control fan speeds and monitor temperatures. In
<img src="https://user-images.githubusercontent.com/7116312/202192004-1bc59976-edd5-4d81-a46c-b9450d677ca8.png" alt="info" width="250" />
</p>

i8kgui uses i8kutils and Sysfs to gather information such as CPU temperature and fan speeds. It also supports thermal management using (SM)BIOS modes.
i8kgui uses `dell-smm-hwmon`, `i8kutils` and Sysfs to gather information such as
CPU temperature and fan speeds. It also supports thermal management using
(SM)BIOS modes.

### Features

* Displays CPU temperature, fan speeds and fan modes
* Displays CPU temperature, fan speed(s) and fan mode(s)
* Displays the current CPU frequency
* Displays CPU load
* Displays individual CPU core frequencies and temperatures
* Displays CPU Turbo information
* Gathers metrics from the `dell_smm_hwmon` kernel module via Sysfs, instead of using `/proc/i8k`
* Gathers metrics from the `dell_smm_hwmon` kernel module via Sysfs, instead of
using `/proc/i8k`
* Shows the currently active i8kutils configuration being used
* Supports (SM)BIOS thermal management modes
* Loads [cpupower-gui](https://github.com/vagnum08/cpupower-gui) (if installed) when `CPU Governor` is clicked
* Option to display CPU frequency as either the highest (default) or the average value for all CPU cores
* Adds polkit action configurations to allow users to change fan modes without a password
* Supports (SM)BIOS thermal management modes via libsmbios
* Loads [cpupower-gui](https://github.com/vagnum08/cpupower-gui) (if installed)
when `CPU Governor` is clicked
* Option to display CPU frequency as either the highest (default) or the average
value for all CPU cores
* Adds polkit action configurations to allow users to change fan modes without a
password

## Installation

### Automated Installation (Recommended)

This version has only been tested on Ubuntu 20.04 (it should also work on 22.04) and with a Dell laptop (XPS 7590). The
installation script undertakes a system-wide installation and installs optional components (i.e. `cpupower-gui` and `undervolt`).
This version has only been tested on Ubuntu 20.04 (it should also work on 22.04)
and with a Dell laptop (XPS 7590). The installation script undertakes a
system-wide installation with all optional components (i.e. `cpupower-gui` and
`undervolt`). Please see below for other install options.

```
git clone https://github.com/razman786/i8kgui
cd i8kgui
./install_i8kgui_ubuntu.sh
```

#### Automated Installation Options

Install option | i8kutils | Dell BIOS fan control | libsmbios | cpupower-gui | undervolt
:---|:---:|:---:|:---:|:---:|:---:
`-all` | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark:
`-norm` | :white_check_mark: | :white_check_mark: | :white_check_mark: | |
`-min` | :white_check_mark: | | | |
`-fix` | :white_check_mark: | :white_check_mark: | | |
`-smbios` | :white_check_mark: | | :white_check_mark: | |
`-power` | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |

See `./install_i8kgui_ubuntu.sh -h` for usage information.

### Manual Installation

#### Prerequisites

This version has only been used on Ubuntu 20.04 and with a Dell XPS laptop.
This guide has only been tested on Ubuntu 20.04 and with a Dell XPS laptop.

The [dell-smm-hwmon](https://www.kernel.org/doc/html/latest/hwmon/dell-smm-hwmon.html)
kernel module is required for basic functionality.

##### i8kutils

Please install and configure i8kutils from https://github.com/vitorafsr/i8kutils. On Ubuntu the following can be run:
Please install and configure i8kutils from
https://github.com/vitorafsr/i8kutils. On Ubuntu the following can be run:

```
sudo apt install i8kutils
```

##### Dell BIOS Fan Control
##### Dell BIOS Fan Control (optional)

Some systems require this step, while others do not. For example, a Dell XPS
7590 needs the BIOS fan control installed, but a Dell Inspiron 5575 does not.

Please install Dell BIOS Fan Control from https://github.com/TomFreudenberg/dell-bios-fan-control and install it
into `/usr/bin/`.
Please install Dell BIOS Fan Control from
https://github.com/TomFreudenberg/dell-bios-fan-control and install it into
`/usr/bin/`.

If you are not sure that you have GCC installed, please run this first `sudo apt install build-essentials`, then:
If you are not sure that you have GCC installed, please run this first `sudo apt
install build-essentials`, then:

```
git clone https://github.com/TomFreudenberg/dell-bios-fan-control.git
Expand All @@ -82,17 +117,20 @@ sudo cp dell-bios-fan-control.service /etc/systemd/system/
sudo systemctl enable dell-bios-fan-control.service
```

##### libsmbios
##### libsmbios (optional)

On Ubuntu 20.04 please install the following package to interface with (SM)BIOS information:
If supported by your system, libsmbios will allow BIOS thermal modes to be changed, amongst other
features. On Ubuntu 20.04, please install the following package to interface with (SM)BIOS
information:

```
sudo apt install python3-libsmbios
```

##### cpupower-gui (optional)

On Ubuntu 20.04 install the following optional package to change the CPU Governor:
On Ubuntu 20.04, install the following optional package to change the CPU
Governor:

```
sudo apt install cpupower-gui
Expand All @@ -107,6 +145,11 @@ git clone https://github.com/razman786/i8kgui
sudo python3 setup.py install
```

Please note that the default installation will use the polkit action files for
Ubuntu. Polkit action files for Manjaro Linux (tested with version 22.1.3) are
located in `i8kgui/polkit_actions/manjaro`. For example, to manually install the
polkit action files, do the following `sudo cp i8kgui/polkit_actions/ubuntu/* /usr/share/polkit-1/actions`

##### Stable

```
Expand All @@ -124,36 +167,51 @@ python3 setup.py install --user

## Usage

Please ensure that you have configured i8kutils before starting!
Please ensure that you have configured i8kutils *before* starting!

Once i8kutils is correctly configured using the `/etc/i8kmon.conf` file, please run the following to start up the services if they are not already
running.
Once i8kutils is correctly configured using the `/etc/i8kmon.conf` file, please
run the following to enable the services if they are not already running.

```
sudo systemctl start dell-bios-fan-control.service && sudo systemctl start i8kmon.service
sudo systemctl enable dell-bios-fan-control.service; sudo systemctl enable i8kmon.service
```

i8kgui can be loaded by searching in Ubuntu's `Show Applications` icon in the application dock. Optionally, i8kgui can be
loaded from a terminal by executing `i8kgui`.
i8kgui can be loaded by searching in Ubuntu's `Show Applications` icon in the
application dock. Optionally, i8kgui can be loaded from a terminal by executing
`i8kgui`.

By default, i8kgui displays i8kutils information, however it does facilitate thermal management using the (SM)BIOS. If you
enable this feature typically four fan modes will be available. Please note that, using 'Quiet', or 'Cool Bottom' modes
will reduce performance due to CPU power capping. Changing (SM)BIOS thermal modes may require entering a user password.
By default, i8kgui displays i8kutils information, however it does facilitate
thermal management using the (SM)BIOS. If you enable this feature typically four
fan modes will be available. Please note that, using 'Quiet', or 'Cool Bottom'
modes will reduce performance due to CPU power capping. Changing (SM)BIOS
thermal modes may require entering a user password, if polkit actions have not
been configured.

Disabling (SM)BIOS thermal management in the settings will re-enable i8kutils's management and configuration.
Disabling (SM)BIOS thermal management in the settings will re-enable i8kutils's
management and configuration.

## Personal configuration

The `i8kmon_sample_conf` directory contains my personal `i8kmon.conf` configuration file, used on a Dell XPS 7590 (Intel i7, BIOS version 1.14.1).
The `i8kmon_sample_conf` directory contains my personal `i8kmon.conf`
configuration file, used on a Dell XPS 7590 (Intel i7, BIOS version 1.14.1).

[Undervolt](https://github.com/georgewhewell/undervolt) is installed using the following settings to avoid thermal throttling:
[Undervolt](https://github.com/georgewhewell/undervolt) is installed using the
following settings to avoid thermal throttling:
```
undervolt -v --gpu -0 --core -121 --cache -121 --uncore -121 --analogio 0 --temp 100
```

## Known Working Systems

Systems that have been reported to be working:

* Dell XPS 7590, Intel i7
* Dell Inspiron 5575, AMD Ryzen 5 - thank you [@yochananmarqos](https://github.com/yochananmarqos)

## Disclaimer

Please note the author takes *no responsibility for any damage* that occurs from using this software and/or configurations.
Please note the author takes *no responsibility for any damage* that occurs from
using this software and/or configurations.

## Issues and requests

Expand Down
Loading

0 comments on commit a1ab8ed

Please sign in to comment.