[mirror_ubuntu-artful-kernel.git] / Documentation / hwmon / userspace-tools

Introduction
------------

Most mainboards have sensor chips to monitor system health (like temperatures,
voltages, fans speed). They are often connected through an I2C bus, but some
are also connected directly through the ISA bus.

The kernel drivers make the data from the sensor chips available in the /sys
virtual filesystem. Userspace tools are then used to display the measured
values or configure the chips in a more friendly manner.

Lm-sensors
----------

Core set of utilities that will allow you to obtain health information,
setup monitoring limits etc. You can get them on their homepage
http://www.lm-sensors.org/ or as a package from your Linux distribution.

If from website:
Get lm-sensors from project web site. Please note, you need only userspace
part, so compile with "make user" and install with "make user_install".

General hints to get things working:

0) get lm-sensors userspace utils
1) compile all drivers in I2C and Hardware Monitoring sections as modules
   in your kernel
2) run sensors-detect script, it will tell you what modules you need to load.
3) load them and run "sensors" command, you should see some results.
4) fix sensors.conf, labels, limits, fan divisors
5) if any more problems consult FAQ, or documentation

Other utilities
---------------

If you want some graphical indicators of system health look for applications
like: gkrellm, ksensors, xsensors, wmtemp, wmsensors, wmgtemp, ksysguardd,
hardware-monitor

If you are server administrator you can try snmpd or mrtgutils.
Commit	Line	Data
828621dd RM	1	Introduction
	2	------------
	3
	4	Most mainboards have sensor chips to monitor system health (like temperatures,
	5	voltages, fans speed). They are often connected through an I2C bus, but some
	6	are also connected directly through the ISA bus.
	7
	8	The kernel drivers make the data from the sensor chips available in the /sys
0d0001dd JD	9	virtual filesystem. Userspace tools are then used to display the measured
0d0001dd JD	10	values or configure the chips in a more friendly manner.
828621dd RM	11
	12	Lm-sensors
	13	----------
	14
0d0001dd	15	Core set of utilities that will allow you to obtain health information,
828621dd	16	setup monitoring limits etc. You can get them on their homepage
ec1d86c4	17	http://www.lm-sensors.org/ or as a package from your Linux distribution.
828621dd RM	18
828621dd RM	19	If from website:
0d0001dd JD	20	Get lm-sensors from project web site. Please note, you need only userspace
0d0001dd JD	21	part, so compile with "make user" and install with "make user_install".
828621dd RM	22
	23	General hints to get things working:
	24
	25	0) get lm-sensors userspace utils
0d0001dd JD	26	1) compile all drivers in I2C and Hardware Monitoring sections as modules
0d0001dd JD	27	in your kernel
828621dd RM	28	2) run sensors-detect script, it will tell you what modules you need to load.
	29	3) load them and run "sensors" command, you should see some results.
	30	4) fix sensors.conf, labels, limits, fan divisors
	31	5) if any more problems consult FAQ, or documentation
	32
0d0001dd JD	33	Other utilities
0d0001dd JD	34	---------------
828621dd RM	35
	36	If you want some graphical indicators of system health look for applications
	37	like: gkrellm, ksensors, xsensors, wmtemp, wmsensors, wmgtemp, ksysguardd,
	38	hardware-monitor
	39
	40	If you are server administrator you can try snmpd or mrtgutils.