TMON(8)

# SPDX-License-Identifier: GPL-2.0

NAME
tmon - A monitoring and testing tool for Linux kernel thermal subsystem

SYNOPSIS
tmon [Options]

DESCRIPTION
tmon can be used to visualize thermal relationship and real-time thermal data; tune and test cooling devices and sensors; collect thermal data for offline analysis and plot. tmon must be run as root in order to control device states via sysfs.

Functions

1. Thermal relationships:
- show thermal zone information
- show cooling device information
- show trip point binding within each thermal zone
- show trip point and cooling device instance bindings

2. Real time data display
- show temperature of all thermal zones w.r.t. its trip points and types
- show states of all cooling devices

3. Thermal relationship learning and device tuning
- with a built-in Proportional Integral Derivative (PID)
controller, user can pair a cooling device to a thermal sensor for
testing the effectiveness and learn about the thermal distance between the two
- allow manual control of cooling device states and target temperature

4. Data logging in /var/tmp/tmon.log
- contains thermal configuration data, i.e. cooling device, thermal
 zones, and trip points. Can be used for data  collection in remote
 debugging.
- log real-time thermal data into space separated format that can be
 directly consumed by plotting tools such as Rscript.

  Options

The -c --control option sets a cooling device type to control temperature of a thermal zone

The -d --daemon option runs tmon as daemon without user interface

The -g --debug option allow debug messages to be stored in syslog

The -h --help option shows help message

The -l --log option write data to /var/tmp/tmon.log

The -t --time-interval option sets the polling interval in seconds

The -T --target-temp option sets the initial target temperature

The -v --version option shows the version of tmon

The -z --zone option sets the target therma zone instance to be controlled

FIELD DESCRIPTIONS

P  passive cooling trip point type
A  active cooling trip point type (fan)
C  critical trip point type
A  hot trip point type
kp  proportional gain of PID controller
ki  integral gain of PID controller
kd  derivative gain of PID controller

REQUIREMENT
Build depends on ncurses

Runtime depends on window size large enough to show the number of devices found on the system.

INTERACTIVE COMMANDS
Ctrl-C, q/Q stops tmon
TAB shows tuning pop up panel, choose a letter to modify

EXAMPLES
Without any parameters, tmon is in monitoring only mode and refresh screen every 1 second.

1. For monitoring only:
$ sudo ./tmon
2. Use Processor cooling device to control thermal zone 0 at default 65C.
$ sudo ./tmon -c Processor -z 0
3. Use intel_powerclamp(idle injection) cooling device to control thermal zone 1
$ sudo ./tmon -c intel_powerclamp -z 1
4. Turn on debug and collect data log at /var/tmp/tmon.log
$ sudo ./tmon -g -l
For example, the log below shows PID controller was adjusting current states
for all cooling devices with "Processor" type such that thermal zone 0
can stay below 65 dC.
#---------- THERMAL DATA LOG STARTED -----------
Samples TargetTemp acpitz0    acpitz1    Fan0 Fan1 Fan2 Fan3 Fan4 Fan5
Fan6 Fan7 Fan8 Fan9 Processor10 Processor11 Processor12 Processor13
LCD14 intel_powerclamp15 1 65.0 65 65 0 0 0 0 0 0 0 0 0 0 0 0 0 0 6 0 2
65.0 66 65 0 0 0 0 0 0 0 0 0 0 4 4 4 4 6 0 3 65.0 60 54 0 0 0 0 0 0 0 0
0 0 4 4 4 4 6 0 4 65.0 53 53 0 0 0 0 0 0 0 0 0 0 4 4 4 4 6 0
5 65.0 52 52 0 0 0 0 0 0 0 0 0 0 0 0 0 0 6 0
6 65.0 53 65 0 0 0 0 0 0 0 0 0 0 0 0 0 0 6 0
7 65.0 68 70 0 0 0 0 0 0 0 0 0 0 0 0 0 0 6 0
8 65.0 68 68 0 0 0 0 0 0 0 0 0 0 5 5 5 5 6 0
9 65.0 68 68 0 0 0 0 0 0 0 0 0 0 6 6 6 6 6 0
10 65.0 67 67 0 0 0 0 0 0 0 0 0 0 7 7 7 7 6 0
11 65.0 67 67 0 0 0 0 0 0 0 0 0 0 8 8 8 8 6 0
12 65.0 67 67 0 0 0 0 0 0 0 0 0 0 8 8 8 8 6 0
13 65.0 67 67 0 0 0 0 0 0 0 0 0 0 9 9 9 9 6 0
14 65.0 66 66 0 0 0 0 0 0 0 0 0 0 10 10 10 10 6 0
15 65.0 66 67 0 0 0 0 0 0 0 0 0 0 10 10 10 10 6 0
16 65.0 66 66 0 0 0 0 0 0 0 0 0 0 11 11 11 11 6 0
17 65.0 66 66 0 0 0 0 0 0 0 0 0 0 11 11 11 11 6 0
18 65.0 64 61 0 0 0 0 0 0 0 0 0 0 11 11 11 11 6 0
19 65.0 60 59 0 0 0 0 0 0 0 0 0 0 12 12 12 12 6 0
Data can be read directly into an array by an example R-script below:
#!/usr/bin/Rscript
tdata <- read.table("/var/tmp/tmon.log", header=T, comment.char="#")
attach(tdata)
jpeg("tmon.jpg")
X11()
g_range <- range(0, intel_powerclamp15, TargetTemp, acpitz0)
plot( Samples, intel_powerclamp15, col="blue", ylim=g_range, axes=FALSE, ann=FALSE)
par(new=TRUE)
lines(TargetTemp, type="o", pch=22, lty=2, col="red")
dev.off()