README.md
1# bsdhwmon
2bsdhwmon is a program for FreeBSD for monitoring hardware sensors (fans, temperatures, voltages, chassis intrusion, and more) on commerical-grade server hardware.
3
4bsdhwmon is developed with a very different mentality compared to other hardware monitoring software:
5
6* Written with stability and production environments in mind
7* Intended for use with server products (currently Supermicro, but can be extended to others that have proper SMBIOS identification data)
8* Uses SMBus ([smb(4)](https://www.freebsd.org/cgi/man.cgi?query=smb&apropos=0&sektion=0&manpath=FreeBSD+9.3-stable&arch=default&format=html) driver) exclusively, significantly decreasing risks and CPU usage compared to classic LPC I/O
9* Based primarily on documentation provided by motherboard/server vendors, combined with documentation from chipset manufacturers
10* Identifies hardware via strict SMBIOS data matching; device "probing" is avoided to minimise false positives and thus risks
11* Full tested on both i386 and amd64 systems across multiple versions of FreeBSD (legacy and present-day)
12* Written entirely in C
13* No reliance on third-party libraries or tools (e.g. autotools, libtool, etc.)
14* Very simple and clean code -- heavily commented, well-documented, built with <code>-Werror -Wall</code> and similar flags
15* Occasionally tested under valgrind
16* Open-source, released under the 2-clause BSD license
17
18## Supported Hardware
19At this time, only a subset of Supermicro hardware is supported. For an official list of supported hardware and models, please see the [doc/SUPPORTED](doc/SUPPORTED) file.
20
21## Supported Operating Systems
22* FreeBSD 9.x (stable/9)
23* FreeBSD 8.x (stable/8)
24* FreeBSD 7.x (stable/7)
25* FreeBSD 6.x (stable/6)
26
27## Unsupported/Untested Operating Systems
28* FreeBSD 11.x (head)
29* FreeBSD 10.x (stable/10)
30
31## Usage
32Please see the [bsdhwmon man page](bsdhwmon.8.txt) for all command-line flags and usage details.
33
34## Support Requests
35For bug reports, enhancements, or general support, please use the [GitHub Issues](https://github.com/koitsu/bsdhwmon/issues) interface.
36
37## Author
38* Jeremy Chadwick <jdc@koitsu.org>
39
40## Repositories
41* Source: https://github.com/koitsu/bsdhwmon
42* Distribution: https://github.com/koitsu/bsdhwmon/releases
43* Distribution (20150429 and older): http://jdc.koitsu.org/freebsd/bsdhwmon-archive/
44
45