| 1 |
OVERVIEW OF THE LM-SENSORS PACKAGE |
| 2 |
================================== |
| 3 |
|
| 4 |
The lm-sensors package, version 3, provides user-space support for the |
| 5 |
hardware monitoring drivers in Linux 2.6.5 and later. For older kernel |
| 6 |
versions, you have to use lm-sensors version 2. |
| 7 |
|
| 8 |
The directories within this package: |
| 9 |
|
| 10 |
* doc |
| 11 |
Documentation. |
| 12 |
* etc |
| 13 |
A sample configuration file for libsensors, and a script to convert |
| 14 |
lm-sensors version 2 configuration files to work with version 3. |
| 15 |
* lib |
| 16 |
The user-space sensors support library code (libsensors). |
| 17 |
* prog |
| 18 |
Several supporting programs. The most important ones are: |
| 19 |
- sensors-detect: A stand-alone program for detecting installed |
| 20 |
hardware and recommending specific modules to load. |
| 21 |
- sensors: A console tool to report sensor readings and set new |
| 22 |
sensor limits. |
| 23 |
- sensord: A daemon to watch sensor values and log problems. It |
| 24 |
includes RRD support. |
| 25 |
* configs |
| 26 |
This directory contains sample configurations of various boards, |
| 27 |
contributed by users of lm-sensors. |
| 28 |
|
| 29 |
All configuration files should now be imported from the old |
| 30 |
www.lm-sensors.org website, however additional information about |
| 31 |
the origin of the configuration files can be found on the old site: |
| 32 |
http://web.archive.org/web/20150901092438/http://www.lm-sensors.org:80/wiki/Configurations |
| 33 |
|
| 34 |
Please contribute back a configuration of your board so other users with |
| 35 |
the same hardware won't need to recreate it again and again. |
| 36 |
|
| 37 |
INSTALLING LM-SENSORS |
| 38 |
--------------------- |
| 39 |
|
| 40 |
See the INSTALL file. |
| 41 |
|
| 42 |
|
| 43 |
HARDWARE SUPPORT |
| 44 |
---------------- |
| 45 |
|
| 46 |
To find out what hardware you have, just run 'sensors-detect' as root. |
| 47 |
|
| 48 |
Most modern mainboards incorporate some form of hardware monitoring chips. |
| 49 |
These chips read things like chip temperatures, fan rotation speeds and |
| 50 |
voltage levels. There are quite a few different chips which can be used by |
| 51 |
mainboard builders for approximately the same results. |
| 52 |
|
| 53 |
Laptops, on the other hand, rarely expose any hardware monitoring |
| 54 |
chip. They often have some BIOS and/or ACPI magic to get the CPU |
| 55 |
temperature value, but that's about it. For such laptops, the lm-sensors |
| 56 |
package is of no use (sensors-detect will not find anything), and you have |
| 57 |
to use acpi instead. |
| 58 |
|
| 59 |
This package doesn't contain chip-specific knowledge. It will support all |
| 60 |
the hardware monitoring chips your kernel has drivers for. In other words, |
| 61 |
if you find out that you have unsupported hardware (e.g. sensors-detect |
| 62 |
told you so) then it means that you need a more recent kernel, or you |
| 63 |
even need to wait for a new kernel driver to be written. Updating the |
| 64 |
lm-sensors package itself will not help. |
| 65 |
|
| 66 |
|
| 67 |
LIBSENSORS |
| 68 |
---------- |
| 69 |
|
| 70 |
The kernel drivers communicate their information through the /sys |
| 71 |
interface. Because every motherboard is different, the drivers always |
| 72 |
advert the measurements at their pins. This means that the values they |
| 73 |
report are not always immediately relevant to you. They have to be |
| 74 |
labelled properly, and sometimes they must be scaled to correspond to |
| 75 |
real-world values. |
| 76 |
|
| 77 |
libsensors is a (shared or static) library of access functions. It |
| 78 |
offers a simple-to-use interface for applications to access the sensor |
| 79 |
chip readings and configure them as you like. It has a configuration |
| 80 |
file where you can put all the motherboard-specific labels and |
| 81 |
conversion rules. That way, all applications do not need to duplicate |
| 82 |
the effort and can simply link with libsensors and work out of the box. |
| 83 |
|
| 84 |
|
| 85 |
APPLICATIONS |
| 86 |
------------ |
| 87 |
|
| 88 |
This package contains an example console program that reports all current |
| 89 |
sensors values. This program is called 'sensors'. You can use it as a |
| 90 |
reference implementation for more intricate programs. It also contains a |
| 91 |
daemon watching for sensor values, logging alarms and feeding an RRD |
| 92 |
database with the sensor measurements. |
| 93 |
|
| 94 |
This package does not contain a nice graphical monitor. See |
| 95 |
http://sensors-applet.sourceforge.net/ |
| 96 |
https://01.org/powertop/ |
| 97 |
https://wpitchoune.net/psensor/ |
| 98 |
https://amanusk.github.io/s-tui/ |
| 99 |
for such programs. |
| 100 |
|
| 101 |
|
| 102 |
TROUBLESHOOTING |
| 103 |
--------------- |
| 104 |
|
| 105 |
lm-sensors is blamed for all kinds of problems on a regular basis. |
| 106 |
While it is always possible that lm-sensors does in fact have a problem, |
| 107 |
almost everytime the problem will be elsewhere. The most likely culprit |
| 108 |
for a problem is one of the kernel drivers providing data to lm-sensors |
| 109 |
or, rather, the sensors command (and libsensors). If you encounter problems, |
| 110 |
the following tests are recommended. |
| 111 |
|
| 112 |
- Check enabled sensors with the 'sensors' command. Observe and, if there |
| 113 |
are errors, write down your test steps and report. |
| 114 |
- If any problems are observed while running the 'sensors' command, disable |
| 115 |
(unload) kernel drivers one after another. After unloading a driver, run |
| 116 |
the 'sensors' command again and observe if the error is gone. If it is, |
| 117 |
you found the problematic driver. Record your tests and report to the driver |
| 118 |
maintainer. |
| 119 |
- If problems are observed while using libsensors from another application, |
| 120 |
the same procedure applies (though it is recommended to perform the test |
| 121 |
with the sensors command first). Again, after identifying the offending |
| 122 |
driver, record and report your results to the driver maintainer. |
| 123 |
- If this does not help, try to run ptrace on the sensors command and/or |
| 124 |
the application using libsensors. If you find any anomalies, record |
| 125 |
your results and report. |
| 126 |
|
| 127 |
|
| 128 |
OTHER INFORMATION |
| 129 |
----------------- |
| 130 |
|
| 131 |
The lm_sensors website can be found at |
| 132 |
https://hwmon.wiki.kernel.org/lm_sensors |
| 133 |
|
| 134 |
The developers of this package can be reached using |
| 135 |
* a mailing list lm-sensors <at> vger <dot> kernel <dot> org |
| 136 |
(you can get information on how to subscribe, unsubscribe, and the list |
| 137 |
of archives at http://vger.kernel.org/vger-lists.html#lm-sensors; |
| 138 |
you do not need to be subscribed to post to the list) |
| 139 |
* GitHub (see https://github.com/lm-sensors/lm-sensors) |
| 140 |
|
| 141 |
Do not hesitate to contact us if you have questions, suggestions, problems, |
| 142 |
want to contribute, or just want to report it works for you. But please try to |
| 143 |
read the documentation before you ask any questions! It's all under doc/. |
| 144 |
|
| 145 |
The latest version of this package can always be found at: |
| 146 |
https://github.com/lm-sensors/lm-sensors. |
| 147 |
|
| 148 |
LICENSE |
| 149 |
------- |
| 150 |
|
| 151 |
The library (libsensors) is released under the GNU Lesser General Public |
| 152 |
License (LGPL), as included in the file COPYING.LGPL. The rest of this |
| 153 |
package may be distributed according to the GNU General Public License |
| 154 |
(GPL), as included in the file COPYING. |