Metadata-Version: 2.1
Name: pi-clap
Version: 1.3
Summary: A python package for clap detection
Home-page: https://pi-clap.nikz.in
Author: Nikhil John
Author-email: ceo@jwala.diamonds
License: MIT
Download-URL: https://github.com/nikhiljohn10/pi-clap
Description: pi-clap
        =======
        
        [![Python package](https://github.com/nikhiljohn10/pi-clap/workflows/Python%20package/badge.svg?branch=master)](https://pypi.python.org/pypi/pi-clap/)
        [![Latest Version](https://img.shields.io/pypi/v/pi-clap)](https://pypi.python.org/pypi/pi-clap/)
        [![Supported Python versions](https://img.shields.io/pypi/pyversions/pi-clap)](https://pypi.python.org/pypi/pi-clap/)
        [![Dependencies](https://img.shields.io/badge/deps-portaudio%2C%20pyaudio%2C%20munch-informational)](https://pypi.python.org/pypi/pi-clap/)
        [![Code Size](https://img.shields.io/github/languages/code-size/nikhiljohn10/pi-clap)](https://pypi.python.org/pypi/pi-clap/)
        [![Downloads](https://img.shields.io/pypi/dm/pi-clap)](https://pypi.python.org/pypi/pi-clap/)
        [![License](https://img.shields.io/pypi/l/pi-clap)](https://github.com/nikhiljohn10/pi-clap/blob/master/LICENSE)
        
        A python package for clap detection
        
        **Platforms Supported:** *Raspberry Pi, Linux, MacOS*
        
        ### Hardware Requirements
        
         * Raspberry Pi
         * Microphone [5]
         * Audio Card [5]
         * Bread Board (optional)
        
        ### Dependencies
        
        **Python 3**
        
         * gpiozero
         * pyaudio ( PortAudio is needed )
         * [munch](https://github.com/Infinidat/munch)
        
        **Other**
        
         * Rasbian OS [3]
         * Audio Driver [1],[2],[3]
        
        ### Setting up Raspberry Pi
        
        1. [Download Raspbian OS](http://www.raspberrypi.org/downloads/)
        2. Install Raspbian OS in RPi [4]
        3. Plugin the USB input audio device(Audio Card or Microphone)
        4. Configure OS after OS bootup [6] `sudo raspi-config`
        5. Update OS `sudo apt-get update && sudo apt-get upgrade -y`
        6. Reboot `sudo reboot` (This should enable the audio driver for the device connected)
        7. Install pip & portaudio module `sudo apt-get install -y python3-pip portaudio19-dev`
        8. Install pi-clap pip module `pip3 install pi-clap`
        9. Connect the output line to BCM #4 & #6 Pin on Raspberry Pi.
        
        ( Try 2 claps to activate the output line for 1 sec and 3 claps to toggle ON/OFF state of given PIN. Note: Use 4 claps to exit from the system )
        
        ### Installing dependencies for other operating systems
        
        ```
        # Debian based OS like Ubuntu
        
        sudo apt-get install -y python3-pip portaudio19-dev
        
        ```
        
        ```
        # Fedora
        
        sudo dnf install -y python3-pip portaudio-devel redhat-rpm-config
        pip3 install --user pyaudio
        
        ```
        
        ```
        # Centos
        
        sudo dnf install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm # CentOS 8
        rpm -Uvh https://dl.fedoraproject.org/pub/epel/7/x86_64/Packages/e/epel-release-7-11.noarch.rpm # CentOS 7
        rpm -Uvh http://download.fedoraproject.org/pub/epel/6/x86_64/epel-release-6-8.noarch.rpm # CentOS 6
        
        sudo yum install -y python37-pip portaudio portaudio-devel
        pip3 install pyaudio
        ```
        
        ```
        # MacOS
        
        brew install portaudio
        pip3 install pyaudio munch || pip3 install --global-option='build_ext' --global-option='-I/usr/local/include' --global-option='-L/usr/local/lib' pyaudio munch
        ```
        
        ### Example code
        
        ```
        # Example code for using the package
        
        from piclap import Listener, Settings
        
        
        class Config(Settings):
        	'''This is an user defined derived class with `piclap.Settings` as base class'''
        
            def __init__(self):
                '''Defines new and override existing properties here'''
                self.chunk_size = 512       # Reduce as power of 2 if pyaudio overflow
                self.interval = 0.5         # Adjust interval between claps
                self.method.value = 300		# Threshold value adjustment
        
            def on2Claps(self):
                '''Custom action for 2 claps'''
                print("Light flashed on pin", 4)
        
            def on3Claps(self):
                '''Custom action for 3 claps'''
                print("Light toggled on pin", 6)
        
        config = Config()
        listener = Listener(config)
        listener.start()
        
        ```
        
        ### Using Pip package
        
        ```
        # Using the following command in terminal
        pip3 install pi-clap
        ```
        
        ### Using Git Clone
        ```
        git clone https://github.com/nikhiljohn10/pi-clap
        cd pi-clap
        python3 ./example/app.py
        ```
        
        ### License
        
        **[MIT License](https://github.com/nikhiljohn10/pi-clap/blob/master/LICENSE)**
        
        Copyright (c) 2020 Nikhil John
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
        ### References
        
         1. https://learn.adafruit.com/usb-audio-cards-with-a-raspberry-pi/instructions
         2. http://computers.tutsplus.com/articles/using-a-usb-audio-device-with-a-raspberry-pi--mac-55876
         3. http://forum.kodi.tv/showthread.php?tid=172072
         4. http://www.raspberrypi.org/documentation/installation/installing-images/
         5. https://raspberrytips.com/add-microphone-raspberry-pi/
         6. https://www.raspberrypi.org/documentation/configuration/
        
Platform: any
Classifier: Intended Audience :: Developers
Classifier: Environment :: Console
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.6
Description-Content-Type: text/markdown
