Metadata-Version: 2.0
Name: tempmon
Version: 0.1.0
Summary: Temperature Monitoring Daemon
Home-page: https://pypi.python.org/pypi
Author: Doug Hellmann
Author-email: doug@doughellmann.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Requires-Dist: temperusb
Requires-Dist: plotly
Requires-Dist: PyYAML

=======================================
 tempmon -- Temperature monitor daemon
=======================================

tempmon uses temperusb_ to read temperature value from TEMPer_ sensors
on the USB bus and publishes them to `plot.ly`_

.. _temperusb: https://pypi.python.org/pypi/temperusb
.. _TEMPer: http://www.amazon.com/gp/product/B002VA813U/ref=as_li_tl?ie=UTF8&camp=1789&creative=390957&creativeASIN=B002VA813U&linkCode=as2&tag=hellflynet-20&linkId=VHDXEZ2QB74BXBM5
.. _plot.ly: https://plot.ly

Setup
=====

1. Sign up for a plot.ly account.
2. From your `plot.ly settings page`_, create one stream token per
   sensor device
3. Install tempmon and its dependencies. A virtualenv works fine for
   this.
4. Create a configuration file using YAML syntax and containing at
   least the basic plot.ly authentication data:

    ::

      username:
      api-key:
      stream-tokens:
        - token1
        - token2

5. Run ``tempmon -c $CONFIG_FILENAME``.  Add ``-v`` to see the log
   output on the console for debugging.

Other Configuration Settings
============================

graph-title

  The title of the graph defaults to "Temperature".

retention-period

  The number of days for which data should be kept. tempmon uses this
  value to compute the number of points to save based on the
  ``frequency``.

frequency

  How often to collect data, in minutes. This value is approximately
  how fast tempmon will poll the device. The minimum frequency is 1
  minute.

units

  The units to report the temperature in. Either ``celsius`` or
  ``fahrenheit``. Defaults to ``fahrenheit``.

.. _plot.ly settings page: https://plot.ly/settings/api



