Metadata-Version: 1.0
Name: Pi-Pin-Manager
Version: 0.0.3
Summary: Manage RPi.GPIO pin definition and initialization with a config file.
Home-page: http://pypi.python.org/pypi/Pi-Pin-Manager/
Author: Brian Hines
Author-email: brian@projectweekend.net
License: LICENSE.txt
Description: This utility exposes a helper class that wraps the [RPi.GPIO]() library so you can define and initialize GPIO pins using a cofiguration file.
        
        
        ### Install It
        
        ```
        pip install Pi-Pin-Manager
        ```
        
        ### Configure It
        
        A config file, written in [YAML](http://en.wikipedia.org/wiki/YAML), is used to define the initial pin setup. If a pin is not defined here it will not be available to the `PinManager`. The following snippet shows an example configuration file:
        
        ```yaml
        18:
          mode: OUT
          initial: HIGH
        23:
          mode: OUT
          initial: LOW
        24:
          mode: IN
          event: RISING
          handler: do_something
          bounce: 200
        ```
        
        * Add a numbered element for each pin to enable
        * `mode` - This controls whether the pin will be used for input or output. Accepted values are: `IN`, `OUT`. (Required)
        * `initial` - This controls the starting value of the pin. Accepted values are: `LOW`, `HIGH`. (Optional - defaults to `LOW`)
        * `resistor` - This controls the software defined pull up/pull down resistor available in the Broadcom SOC. Accepted values are: `PUD_UP`, `PUD_DOWN`. (Optional - defaults to none)
        * `event` - Work in progress... This is used in combination with a pin set to input mode (`mode: IN`). Accepted values are: `RISING`, `FALLING`, `BOTH`.
        * `handler` - Work in progress... This is used in combination with an `event` to designate a function to call when an `event` happens. This value should correspond to a function defined in your handler class.
        * `bounce` - Work in progress... This can be used when an `event` is defined to prevent multiple `handler` calls being fired accidentally. The value is the number of milliseconds to wait before detecting another `event`.
        
        **Note:**
        
        For full documentation about available GPIO input pin configurations see the [documentation](http://sourceforge.net/p/raspberry-gpio-python/wiki/Examples/).
        
        
        ### Use It (No Events)
        
        ```python
        from pi_pin_manager import PinManager
        
        
        pins = PinManager(config_file='path/to/config/file.yml')
        
        
        # Read a pin
        result = pins.read(18)
        
        # Write to a pin
        result = pins.write(19, 1)
        
        # Get configuration for a pin
        result = pins.get_config(23)
        ```
        
        ### Use It (With Events)
        
        If an `event` and `handler` have been defined for a pin in the config file, then you must also provide a class that contains the callbacks to execute. Each method you add to this class should match the name of a `handler` value. Based on the example code below, `handler: do_something` is expected in the config file `path/to/config/file.yml`.
        
        ```python
        from pi_pin_manager import PinManager
        
        
        class EventHandlers(object):
        
            def do_something(self, pin_number, event):
                # Whatever you want to trigger when an event is detected goes here
                print('Event "{0}" on pin {1}'.format(event, pin_number))
        
        
        pins = PinManager(config_file='path/to/config/file.yml', event_handlers=EventHandlers())
        ```
        
        **Exceptions:**
        
        This package may raise the following custom exceptions:
        
        * `PinNotDefinedError` - This is raised when attempting to `read` or `write` to a pin that is not defined in the configuration file.
        * `PinConfigurationError` - This is raised when attempting to perform an action on a pin that does not match its configuration. For example, trying to `write` to a pin not defined as `mode: OUT`.
        
Platform: UNKNOWN
