IMPLib2 0.12.0

Travis-CI & Test Coverage
=========================

**Stable Branch (0.12.0)**

`|Build Status| <https://travis-ci.org/mhubig/implib2>`_ `|Test
Coverage| <https://codecov.io/gh/mhubig/implib2/branch/master>`_
`|Dependecy CI| <https://dependencyci.com/github/mhubig/implib2>`_

**Development Branch**

`|image3| <https://travis-ci.org/mhubig/implib2>`_
`|image4| <https://codecov.io/gh/mhubig/implib2/branch/develop>`_
`|image5| <https://dependencyci.com/github/mhubig/implib2>`_

Requirements
------------

Before you can start using the IMPLib2 software you have to make sure,
that you have at least the following software packages installed.

- Python 2.7 (http://python.org)
- PySerial (http://pyserial.sourceforge.net)

For instructions on how to get and install these packages on your OS
please head over to the official project pages.

Installation
------------

Install the stable branch using pip::

::

$ pip install implib2

Of if you brave enough::

::

$ pip install git+https://github.com/mhubig/implib2.git@develop

Depending on your system you may have to prefix these commands with
``sudo``!

Quick Start Manual
------------------

This small quick start manual is intended to give you a basic example of
how to use this library. In order to start playing with it you have to
connect at least one `Trime
Pico <http://imko.de/en/products/soilmoisture>`_ moisture measurement
probe to your computer. An easy way to connect the probe is by using the
USB-IMPBus Converter `SM-USB <http://imko.de/en/products>`_.

After successfully installing IMPLib2 and connecting, start the Python
Shell within your terminal::

::

$ python
Python 2.7.3 (default, Aug 1 2012, 05:14:39)
[GCC 4.6.3] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>>

Import the IMPLib2 module::

::

>>> import implib2 as imp

Now initialize the IMPBus, sync and scan for connected Modules. Replace
the USB Interface with the one your SM-USB uses::

::

>>> bus = imp.Bus('/dev/ttyUSB0')
>>> bus.sync()
>>> bus.scan()
(10010, 10011)

As you can see we found two connected modules with the serial numbers
10010 and 10011. Now we can instantiate the module objects::

::

>>> mod10 = imp.Module(bus, 10010)
>>> mod11 = imp.Module(bus, 10011)

Using the handy module objects we can now perform various higher
operations, like doing a measurement or requesting the serial number::

::

>>> mod10.get_moisture()
14.3
>>> mod11.get_moisture()
17.4
>>> mod10.get_serno()
10010
>>> mod11.get_serno()
10011

If you came so far you should be able to easily build a little script
which performs an measurement on all connected probes ones an hour::

::

#!/usr/bin/env python
# -*- coding: UTF-8 -*-

import time
import implib2 as imp

# Initialize the IMPBus2
bus = imp.Bus('/dev/ttyUSB0')
bus.sync()

# Search the bus for connected modules
modules = [imp.Module(bus, serno) for serno in bus.scan()]

# Start a measurement and show the results once an hour
while True:
for module in modules:
serno = module.get_serno()
moist = module.get_moisture()
mtemp = module.get_measure(quantity='MeasTemp')
print "Module {}: Moist {}, Temp {}".format(serno, moist, mtemp)

time.sleep(3600) # for one hour

For more and in depth information please head over to the
API-Documentation on `Read the Docs <https://implib2.readthedocs.org>`_.

MIT License
-----------

Copyright (c) 2011-2016 Markus Hubig

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files
(the "Software"), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of the Software,
and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

.. |Build
Status| image:: https://travis-ci.org/mhubig/implib2.svg?branch=master
.. |Test
Coverage| image:: https://codecov.io/gh/mhubig/implib2/coverage.svg?branch=master
.. |Dependecy
CI| image:: https://dependencyci.com/github/mhubig/implib2/badge
.. |image3| image:: https://travis-ci.org/mhubig/implib2.svg?branch=develop
.. |image4| image:: https://codecov.io/gh/mhubig/implib2/coverage.svg?branch=develop
.. |image5| image:: https://dependencyci.com/github/mhubig/implib2/badge