eboxy lm_sensors plugin (hwsensors) 0.1
---------------------------------------

hwsensors is a plugin for eboxy which provides a very simple interface for
getting information from hardware sensors (temperature, fan speed etc.)
via the lm_sensors system (http://www.lm-sensors.nu). This plugin has been
tested with lm_sensors 2.70, earlier versions may or may not work. For
details on how to install and configure lm_sensors please refer to the
lm_sensors documentation.


Compiling
---------

Run make and (as root) make install.

If your system is set up in a non-standard way you may have to modify the
makefile slightly. In the future this plugin will use autoconf/automake to
avoid this.


Usage
-----

To load the plugin, you need to add a <plugin> section into your XML file,
and then access the plugin from the "hwsensors" object which the plugin
creates, eg.:

...
<pages>
  <page...>
    <plugin module="hwsensors" />
    <event type="OnShow">
      somelabel.caption = hwsensors.readsensor("it87-isa-0290", "temp1") + " C"
    </event>
    <label name="somelabel" .../>
    ...
  </page>
</pages>
...

As you can see, you need to pass in the name of the sensor chip to read as
well as the reading you are interested in. You can find out what the names
of these are by using the "sensors" command that is installed with
lm_sensors. Type sensors -u for a list of sensor chip names and available
reading names for each chip (the name in brackets for each reading is what
you need to use).

Hint: you may want to use a timer to update the label with the sensor value,
so that the latest value is always displayed. If you do this, use a timer
interval of no less than 1500 (1.5 seconds) since the lm_sensors library will
not update any faster than this, due to the way the hardware works.


Reference
---------

Properties:

none.

Methods:

  readsensor(chipname, readingname)
    Reads the value of a hardware sensor. chipname is the name of the chip,
    and readingname is the name of the reading you want. Returns a string
    containing the value of the reading fixed to 1 decimal place.

Events:

none.


Known issues
------------

- hwsensors will crash eboxy if you specify an incorrect chip name or reading
  name. If you have any idea how to fix this, please let me know!


eboxy
-----

eboxy is a GUI system for set-top boxes. For more information on eboxy, visit:

  http://www.bluelightning.org/eboxy

Please contact me, Paul Eggleton, at bluelightning@bluelightning.org with any
questions or suggestions.


Licence
-------

This plugin is released under the GPL, version 2 (or a later version, at your
option). For more information on the GNU GPL please visit http://www.fsf.org.
