IMPLib2 0.9.1 (beta)

Python implementation of the IMPBUS-2 data transmission protocol.

Travis-CI & Test Coverage

Stable Branch (0.9.1)

Development Branch

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 2.6 (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 moisture measurement probe to your computer. An easy way to connect the probe is by using the USB-IMPBus Converter SM-USB.

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 = Module(bus, 10010)
>>> mod11 = 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
>>> mos11.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.

License

Copyright (C) 2011-2013, Markus Hubig <mhubig@imko.de>

This is the documentation part of IMPLib2, a small Python library
implementing the IMPBUS-2 data transmission protocol.

IMPLib2 is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as
published by the Free Software Foundation, either version 3 of
the License, or (at your option) any later version.

IMPLib2 is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with IMPLib2. If not, see <http://www.gnu.org/licenses/>.