Metadata-Version: 2.0
Name: iotrelay-influxdb
Version: 1.7.0
Summary: InfluxDB handler module for iotrelay
Home-page: https://github.com/eman/iotrelay-influxdb
Author: Emmanuel Levijarvi
Author-email: emansl@gmail.com
License: BSD
Keywords: influxdb IoT
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Home Automation
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Requires-Dist: iotrelay (>=1.2)
Requires-Dist: influxdb (>=3.0.0)

IoT Relay - InfluxDB
----------------------------------------------------------------------------
version 1.7.0

iotrelay-influxdb is a data handler plugin for IoT Relay. It watches for
data it has registered an interest in and relays it in batches to a
InfluxDB time series database. See the `IoT Relay Documentation
<https://github.com/eman/iotrelay>`_ for more.

iotrelay-influxdb is available on PyPI and can be installed via pip.

.. code-block:: bash

    $ pip install iotrelay-influxdb

Before using iotrelay-influxdb a database must be
created. See https://influxdata.com/ for more.
to the IOT Relay configuration file, ``~/.iotrelay.cfg`` once they have
been given by InfluxDB.

.. code-block:: ini

    [iotrelay-influxdb]
    host = influxdb hostname
    username = influxdb password
    password = influxdb password
    enable_ssl = True

The ``reading types`` to be relayed to InfluxDB should also be
registered. In this example, reading types of power and weather will be
relayed to InfluxDB.

.. code-block:: ini

    [iotrelay-influxdb]
    reading types = power, weather
    host = influxdb hostname
    username = influxdb username
    password = influxdb password

By default iotrelay-influxdb will batch 30 readings of each type before
sending the batch to InfluxDB. In the previous example, two separate
batches would be maintained for power and weather readings. The batch
size may be changed by adding the ``batch size`` option to the
``iotrelay-influx`` section of ``~/.iotrelay.cfg``.

.. code-block:: ini

    [iotrelay-influxdb]
    batch size = 30
    reading types = power, weather
    host = influxdb hostname
    username = influxdb username
    password = influxdb password


License
===============================================================================
Copyright © 2016, Emmanuel Levijarvi
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


