xref: /linux/tools/thermal/thermometer/thermometer.8 (revision 4b132aacb0768ac1e652cf517097ea6f237214b9)
THERMOMETER 8
# SPDX-License-Identifier: GPL-2.0
NAME
thermometer - A thermal profiling tool
SYNOPSIS
thermometer [ options ] [ command ]

DESCRIPTION
thermometer captures the thermal zones temperature at a specified sampling period. It is optimized to reduce as much as possible the overhead while doing the temperature acquisition in order to prevent disrupting the running application we may want to profile. This low overhead also allows a high rate sampling for the temperature which could be necessary to spot overshots and undershots. If no configuration file is specified, then all the thermal zones will be monitored at 4Hz, so every 250ms. A configuration file specifies the thermal zone names and the desired sampling period. A thermal zone name can be a regular expression to specify a group of thermal zone. The sampling of the different thermal zones will be written into separate files with the thermal zone name. It is possible to specify a postfix to identify them for example for a specific scenario. The output directory can be specified in addition. Without any parameters, thermometer captures all the thermal zone temperatures every 250ms and write to the current directory the captured files postfixed with the current date. If a running duration is specified or a command, the capture ends at the end of the duration if the command did not finished before. The duration can be specified alone as well as the command. If none is specified, the capture will continue indefinitively until interrupted by SIGINT or SIGQUIT.

Options

The -h, --help option shows a short usage help

The -o <dir>, --output <dir> option defines the output directory to put the sampling files

The -c <config>, --config <config> option specifies the configuration file to use

The -d <seconds>, --duration <seconds> option specifies the duration of the capture

The -l <loglevel>, --loglevel <loglevel> option sets the loglevel [DEBUG,INFO,NOTICE,WARN,ERROR]

The -p <string>, --postfix <string> option appends string at the end of the capture filenames

The -s, --syslog option sets the output to syslog, default is stdout

The -w, --overwrite overwrites the output files if they exist

"Exit status:"

0 if OK,

1 Error with the options specified as parameters

2 Error when configuring the logging facility

3 Error when configuring the time

4 Error in the initialization routine

5 Error during the runtime

Capture file format
Every file contains two columns. The first one is the uptime timestamp in order to find a point in time since the system started up if there is any thermal event. The second one is the temperature in milli degree. The first line contains the label of each column.
AUTHOR
Daniel Lezcano <daniel.lezcano@kernel.org>