Metadata-Version: 1.1
Name: tellcore-py
Version: 1.0.1
Summary: Python wrapper for Telldus' home automation library
Home-page: https://github.com/erijo/tellcore-py
Author: Erik Johansson
Author-email: erik@ejohansson.se
License: GPLv3+
Description: Python wrapper for Telldus Core
        ===============================
        
        tellcore-py is a Python wrapper for `Telldus' <http://www.telldus.com/>`_ home
        automation library `Telldus Core <http://developer.telldus.se/doxygen/>`_.
        
        * Documentation: https://tellcore-py.readthedocs.org/
        * Official home page: https://github.com/erijo/tellcore-py
        * Python package index: https://pypi.python.org/pypi/tellcore-py
        
        Please report any problem as a `GitHub issue report
        <https://github.com/erijo/tellcore-py/issues/new>`_.
        
        Features
        --------
        
        * Wraps the C-interface with a python interface (with classes and exceptions).
        * Automatically frees memory for returned strings.
        * Throws an exception (TelldusError) in case a library function returns an
          error.
        * Supports python 3 with automatic handling of strings (i.e. converting between
          bytes used by the C-library and strings as used by python).
        * Takes care of making callbacks from the library thread-safe.
        * Unit tested.
        * Besides being useful with the regular Python implementation (a.k.a. `CPython
          <http://en.wikipedia.org/wiki/CPython>`_), it also works with `pypy
          <http://pypy.org/>`_.
        * Open source (`GPLv3+
          <https://github.com/erijo/tellcore-py/blob/master/LICENSE.txt>`_).
        * Works on Linux, Mac OS X and Windows.
        
        Requirements
        ------------
        
        * Python
        * `Telldus Core library <http://telldus.com/products/nativesoftware>`_
        
        Installation
        ------------
        
        * Easiest is to install the package from `Python Package Index
          <https://pypi.python.org/pypi/tellcore-py>`_ by running: pip install
          tellcore-py
        
        * Can also be installed by cloning the `GIP repository
          <https://github.com/erijo/tellcore-py>`_ or downloading the `ZIP archive
          <https://github.com/erijo/tellcore-py/archive/master.zip>`_ from GitHub and
          unpacking it. Then change directory to tellcore-py and run =python setup.py
          install=.
        
        Users
        -----
        
        * `Tellprox <https://github.com/p3tecracknell/tellprox/>`_ - A local server to
          use in place of Telldus Live
        * `tellive-py <https://github.com/erijo/tellive-py>`_ - A Python wrapper for
          Telldus Live
        
        Example
        -------
        
        A simple example for adding a new "lamp" device, turning it on and then turning
        all devices off. ::
        
            from tellcore.telldus import TelldusCore
        
            core = TelldusCore()
            lamp = core.add_device("lamp", "arctech", "selflearning-switch", house=12345, unit=1)
            lamp.turn_on()
        
            for device in core.devices():
                device.turn_off()
        
        More examples can be found in the `bin
        <https://github.com/erijo/tellcore-py/tree/master/bin>`_ directory.
        
        Internals
        ---------
        
        At the bottom there is the Library class which is a `ctypes
        <http://docs.python.org/library/ctypes.html>`_ wrapper and closely matches the
        API of the underlying Telldus Core library. The library class takes care of
        freeing memory returned from the base library and converts errors returned to
        TelldusException. The library class is not intended to be used directly.
        
        Instead, the TelldusCore class provides a more python-ish API on top of the
        library class. This class is used for e.g. adding new devices, or enumerating
        the existing devices, sensors and/or controllers. E.g. calling the devices()
        method returns a list of Device instances. The Device class in turn has methods
        for turning the device on, off, etc.
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Home Automation
