Metadata-Version: 1.1
Name: plugable-btaps
Version: 0.8.3
Summary: Open Source Library for Controlling the Plugable PS-BTAPS1 Bluetooth AC Outlet Switch
Home-page: https://github.com/bernieplug/plugable-btaps
Author: Plugable Technologies
Author-email: ivan@plugable.com
License: MIT
Description: Plugable PS-BTAPS1 Library and CLI
        ==================================
        
        Description
        ___________
        This project is a library and command-line interface for communicating with and programming a `Plugable PS-BTAPS1 Bluetooth Home Automation Switch`_.
        
        libbtaps.py 
            Serves as a Python implementation of the BTAPS protocol, either to be used directly in your programs, or to be used as a reference in developing your own implementation in a different language.
        btaps.py 
            A simple command-line UI that implements all the features exposed by libbtaps.py.
        
        ::
        
            USAGE:   python btaps.py [Bluetooth address]
            EXAMPLE: python btaps.py 00:00:FF:FF:00:00
        
        Implemented Functionality
        _________________________
        The following functions of the Plugable PS-BTAPS1 are currently present in the library:
         - Setting Switch On/Off
         - Reading current status of switch(name, on/off, timer settings)
         - Creating, modifying and deleting timers
         - Changing the device's name
         - Updating the device's date and time to your PC's current date and time
         
        TO DO
        _____
        The following features and items are still to come:
         - NFControl (Device proximity on/off functionality)
         - Security PIN
         - Better error handling
         - Better documentation
         - Mac OS X support
        
        OS Support
        __________
        Due to PyBluez limitations, this library will currently only work on Linux and Windows systems.
        
        Dependencies
        ____________
         - `Python 2.7.x`_
         - PyBluez_
        
        Installation
        ____________
        First, install PyBluez using the appropriate link or command for your OS:
        
        **Windows**
            Download and install `PyBluez for Python 2.7`_
        
        **Ubuntu/Debian**::
        
            sudo apt-get install python-bluez
        
        **Fedora**::
        
            sudo yum install pybluez
        
        **Arch**::
        
            sudo pacman -S python2-pybluez
        
        Then, simply pip install our module:::
        
            pip install plugable-btaps
        
        libbtaps Docs and Examples
        __________________________
        Find some usage examples and documentation for libbtaps in `DOCUMENTATION.rst`_
        
        Troubleshooting
        _______________
        When I try to pip install plugable-btaps I get a compilation error:
            This means that you have not installed PyBluez and pip is trying to compile PyBluez from source, but you don't have the necessary compilation dependencies installed on your system.
            Install PyBluez as outlined above.
        
        .. _Plugable PS-BTAPS1 Bluetooth Home Automation Switch: http://plugable.com/products/ps-btaps1/
        .. _PyBluez: https://code.google.com/p/pybluez/
        .. _Python 2.7.x: https://www.python.org/
        .. _PyBluez for Python 2.7: https://code.google.com/p/pybluez/downloads/detail?name=PyBluez-0.20.win32-py2.7.exe
        .. _DOCUMENTATION.rst: https://github.com/bernieplug/plugable-btaps/wiki/libbtaps-Documentation-and-Examples
Keywords: bluetooth home-automation
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Home Automation
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2 :: Only
Classifier: Programming Language :: Python :: 2.7
Classifier: Environment :: Console
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
