2010-05-13 03:49:17 -07:00
|
|
|
/**
|
|
|
|
@file eeze.dox
|
2010-05-22 00:04:00 -07:00
|
|
|
@brief Eeze Device Library
|
2010-05-13 03:49:17 -07:00
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
@mainpage Eeze
|
|
|
|
@image html eeze.png
|
|
|
|
@version @PACKAGE_VERSION@
|
|
|
|
@author Mike Blumenkrantz (zmike/discomfitor) <mike@zentific.com>
|
|
|
|
@date 2010
|
|
|
|
|
|
|
|
@section intro What is Eeze?
|
|
|
|
|
2010-08-30 01:20:09 -07:00
|
|
|
Eeze is a library for manipulating devices through udev with a simple and fast
|
|
|
|
api. It interfaces directly with libudev, avoiding such middleman daemons as
|
|
|
|
udisks/upower or hal, to immediately gather device information the instant it
|
|
|
|
becomes known to the system. This can be used to determine such things as:
|
2010-09-20 13:07:24 -07:00
|
|
|
@li If a cdrom has a disk inserted
|
|
|
|
@li The temperature of a cpu core
|
|
|
|
@li The remaining power left in a battery
|
|
|
|
@li The current power consumption of various parts
|
|
|
|
@li Monitor in realtime the status of peripheral devices
|
2010-08-30 01:20:09 -07:00
|
|
|
|
|
|
|
Each of the above examples can be performed by using only a single eeze
|
|
|
|
function, as one of the primary focuses of the library is to reduce the
|
|
|
|
complexity of managing devices.
|
2010-05-13 03:49:17 -07:00
|
|
|
|
2010-10-15 20:57:54 -07:00
|
|
|
@li @link Eeze.h Eeze functions @endlink
|
|
|
|
@li @ref udev UDEV functions
|
|
|
|
@li @ref watch Functions that watch for events
|
|
|
|
@li @ref syspath Functions that accept a device /sys/ path
|
|
|
|
@li @ref find Functions which find types of devices
|
|
|
|
|
2010-05-13 03:49:17 -07:00
|
|
|
@verbatim
|
|
|
|
Pants
|
|
|
|
@endverbatim
|
|
|
|
*/
|