user_manual.md

WARNING - IMPORTANT

With this Program can you set manually the fan speed of your TUXEDO Notebook. You can destroy your Notebook, when you set a to low fan speed!

Table of Content

• WARNING - IMPORTANT
• Table of Content
• Induction
• Dependencies
• UI
• Installation
  • Ubuntu
  • Files and locations
• Daemon
  • Systemd - Create Service File
  • Systemd - Control the Daemon
• Commandline Interface (CLI)
  • Parameter
    • -h / --help
    • -v / --version
    • --startdaemon
    • --stopdaemon
    • --restartdaemon
    • --statusdaemon
    • --createunitfile
    • --removeunitfile

Induction

The TUXEDO Fan Control is a Application and Daemon for controlling the fans of CPU and GPU of your TUXEDO Notebook device.

Dependencies

• NVIDIA SMI for Controlling the NVIDIA GPU Fan (Only need at devices with nvidia graphic cards)
• Xvfb (X Window Virtual Framebuffer)

UI

The UI of the TUXEDO Fan Control show you the Stats of the CPU and GPU Fans.
The Informations are

• Temperature
• Fan Duty in Percent
• Fan Speed in RPM

When the Daemon is activ in the backgroud, you can not set the fan duty over the UI.

Installation

Ubuntu

apt install /tuxedofancontrol__amd64.deb Example, the deb file, with the version 0.0.4, is located under the Download dir of the user "tux"

apt install /home/tux/Downloads/tuxedofancontrol_0.0.4_amd64.deb

We recommend apt for the installation, because apt install the package dependencies of TUXEDO Fan Control.

Files and locations

Installation dir: /opt/tuxedofancontrol/
Log dir: /var/log/tuxedo-fan/

Daemon

The TUXEDO Fan Control Daemon check every second the CPU and GPU temperature and set the fan duty, if need it.

Systemd - Create Service File

Create the Service file under /etc/systemd/system/ with the Name "tuxedofancontrol.service"

[Unit]
Description=TUXEDO Fan Control

[Service]
Type=forking
ExecStart=/bin/bash -c "Xvfb :98 -screen 0 1x1x16 & export DISPLAY=:98 && <path>/tuxedofancontrol --startdaemon"
ExecStop=/bin/bash -c "Xvfb :98 -screen 0 1x1x16 & export DISPLAY=:98 && <path>/tuxedofancontrol --stopdaemon"
ExecReload=/bin/bash -c "Xvfb :98 -screen 0 1x1x16 & export DISPLAY=:98 && <path>/tuxedofancontrol --restartdaemon"

Restart=always

[Install]
WantedBy=multi-user.target

Systemd - Control the Daemon

Enable

systemctl enable tuxedofancontrol

Disable

systemctl disable tuxedofancontrol

Start

systemctl start tuxedofancontrol

Stop

systemctl stop tuxedofancontrol

Restart

systemctl restart tuxedofancontrol

Commandline Interface (CLI)

Parameter

-h / --help

Print all the Parameters and Descriptions

-v / --version

Print the Version of TUXEDO Fan Control

--startdaemon

Start the TUXEDO Fan Control Daemon

--stopdaemon

Stop the TUXEDO Fan Control Daemon

--restartdaemon

Restart the TUXEDO Fan Control Daemon

--statusdaemon

Print the Status TUXEDO Fan Control Daemon

--createunitfile

Create Unit File for Systemd

--removeunitfile

Remove Unit File for Systemd