Metadata-Version: 1.1
Name: Adafruit_BBIO
Version: 0.0.15
Summary: A module to control BeagleBone IO channels
Home-page: https://github.com/adafruit/adafruit-beaglebone-io-python/
Author: Justin Cooper
Author-email: justin@adafruit.com
License: MIT
Description: **Adafruit's BeagleBone IO Python Library**
        
        This is a set of Python tools to allow GPIO, PWM, and ADC access on the BeagleBone using the Linux 3.8 Kernel and above (latest releases).
        
        It has been tested on the 5-20 and 6-6 Angstrom image on the BeagleBone Black.
        
        **Note: BBIO has been renamed to Adafruit_BBIO.**
        
        **Installation on Angstrom**
        
        Easiest::
        
            /usr/bin/ntpdate -b -s -u pool.ntp.org
            opkg update && opkg install python-pip python-setuptools
            pip install Adafruit_BBIO
            
        Manual::
        
            git clone git://github.com/adafruit/adafruit-beaglebone-io-python.git 
            #set the date and time 
            /usr/bin/ntpdate -b -s -u pool.ntp.org 
            #install dependency 
            opkg update && opkg install python-distutils 
            cd adafruit-beaglebone-io-python 
            python setup.py install
        
        **Installation on Ubuntu**
        
        Easiest::
        
            sudo ntpdate pool.ntp.org
            sudo apt-get update
            sudo apt-get install build-essential python-dev python-pip -y
            sudo pip install Adafruit_BBIO
            
        Manual::
        
            sudo ntpdate pool.ntp.org
            sudo apt-get update
            sudo apt-get install build-essential python-dev python-pip -y
            git clone git://github.com/adafruit/adafruit-beaglebone-io-python.git
            cd adafruit-beaglebone-io-python
            sudo python setup.py install
            cd ..
            sudo rm -rf adafruit-beaglebone-io-python
            
        **Usage**
        
        Using the library is very similar to the excellent RPi.GPIO library used on the Raspberry Pi. Below are some examples.
        
        **GPIO Setup** 
        
        Import the library, and setup as GPIO.OUT or GPIO.IN::
        
            import Adafruit_BBIO.GPIO as GPIO
            GPIO.setup("P8_14", GPIO.OUT)
        
        You can also refer to the pin names::
        
            GPIO.setup("GPIO0_26", GPIO.OUT)
        
        **GPIO Output** 
        
        Setup the pin for output, and write GPIO.HIGH or GPIO.LOW. Or you can use 1 or 0.::
        
            import Adafruit_BBIO.GPIO as GPIO
            GPIO.setup("P8_14", GPIO.OUT) GPIO.output("P8_14", GPIO.HIGH)
            
        **GPIO Input**
        
        Inputs work similarly to outputs.::
        
            import Adafruit_BBIO.GPIO as GPIO
            GPIO.setup("P8_14", GPIO.IN)
            
        Polling inputs::
            
            if GPIO.input("P8_14"):
              print("HIGH")
            else:
              print("LOW")
        
        Waiting for an edge (GPIO.RISING, GPIO.FALLING, or GPIO.BOTH::
        
            GPIO.wait_for_edge(channel, GPIO.RISING)
        
        Detecting events::
        
            GPIO.add_event_detect("P9_12", GPIO.FALLING) 
            #your amazing code here 
            #detect wherever: 
            if GPIO.event_detected("P9_12"):
              print "event detected!"
        
        **PWM**::
        
            import Adafruit_BBIO.PWM as PWM 
            #PWM.start(channel, duty, freq=2000) 
            #duty values are valid 0-100 
            PWM.start("P9_14", 50)
            PWM.set_duty_cycle("P9_14", 25.5) PWM.set_frequency("P9_14", 10)
        
            PWM.stop("P9_14")
            PWM.cleanup()
        
        **ADC**::
        
            import Adafruit_BBIO.ADC as ADC
            ADC.setup()
        
            #read returns values 0-1.0 
            value = ADC.read("P9_40")
        
            #read_raw returns non-normalized value 
            value = ADC.read_raw("P9_40")
        
        **Running tests**
        
        Install py.test to run the tests. You'll also need the python compiler package for py.test.::
        
            opkg update && opkg install python-compiler 
            #Either pip or easy_install 
            pip install -U pytest 
            easy_install -U pytest
        
        Execute the following in the root of the project::
        
            py.test
            
        **Credits**
        
        The BeagleBone IO Python library was originally forked from the excellent MIT Licensed [RPi.GPIO](https://code.google.com/p/raspberry-gpio-python) library written by Ben Croston.
        
        **License**
        
        Written by Justin Cooper, Adafruit Industries. BeagleBone IO Python library is released under the MIT License.
        0.0.15
        * Fix PWM duty cycle so 0 is off and 100 is on.  Set polarity to 0 by default.
        * Give extra buffer space in export, and unexport functions for gpio that are more than 2 digits (Chris Desjardins)
        * Add new test case for 3 digit gpio (Chris Desjardins)
        * Fix for test_direction_readback. gpio_get_direction wasn't properly null terminating the direction string (Chris Desjardins)
        
        0.0.14
        ----
        * Fix GPIO.gpio_function to work with the IO name (zthorson)
        * Fix IOErrors not getting raised when fopen fails while loading overlays into device tree (bradfordboyle, jwcooper)
        * Add new UART tests
        
        0.0.13
        ----
        * Remove the gpio parameter from callbacks (cdesjardins)
        
        0.0.12
        ----
        * Bump version due to pypi issues
        
        0.0.11
        ----
        * New UART module to export UART overlays
        * Alpha support for SPI
        * Add small delay after loading any device tree overlays
        
        0.0.10
        ____
        * Fix direction for event detection code
        * Fix for segmentation faults on add_event_detect
        
        0.0.9
        ____
        * Fix for ADC Segmentation Faults
        
        0.0.8
        ____
        * Temp remove overlay compilation.  Ubuntu failures.
        
        0.0.7
        ____
        * Refactor and clean up adc and pwm
        * Fix tests for Adafruit_BBIO rename
        
        0.0.6
        ____
        * Include Adafruit_I2C.py as top-level module
        
        0.0.5
        ----
        * Rename from BBIO to Adafruit_BBIO to reduce library conflicts and confusion.
        
        0.0.4
        ----
        * Support for pip and easy_install
        
        0.0.3
        ____
        * ADC enabled
        
        0.0.2
        ____
        * PWM enabled
        
        0.0.1
        ____
        * Initial Commit
        * GPIO mostly working
        * Initial GPIO unit tests
        * PWM in progress
        
Keywords: Adafruit BeagleBone IO GPIO PWM ADC
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Operating System :: POSIX :: Linux
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development
Classifier: Topic :: Home Automation
Classifier: Topic :: System :: Hardware
