Skip to main content

A python package for clap detection

Project description

pi-clap

Python package Latest Version Supported Python versions Dependencies Code Size Downloads License

A python package for clap detection

Platforms Supported: Raspberry Pi, Linux, MacOS

H/w Requirements

  • Raspberry Pi
  • Microphone [5]
  • Audio Card [5]
  • Bread Board (optional)

Dependencies

Python 3

  • RPi.GPIO
  • pyaudio ( PortAudio is needed )
  • munch

Other

  • Rasbian OS [3]
  • Audio Driver [1],[2],[3]

Setting up Raspberry Pi

  1. Download Raspbian OS
  2. Install Raspbian OS in RPi
  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 #24 & #13 Pin on RPi.

( 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.listener import Listener
from piclap.settings import Settings

def main():
    config = Settings()             # Optional
    config.chunk_size = 512         # Reduce as power of 2 if pyaudio overflow
    config.interval = 1             # Adjust interval between claps
    config.customPin = 13           # Custom config variable
    listener = Listener(config)     # 'config' argument is optional
    listener.start()

if __name__ == '__main__':
    main()

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 tests/app.py

License

MIT

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/

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pi-clap-1.2.0.tar.gz (5.1 kB view hashes)

Uploaded Source

Built Distribution

pi_clap-1.2.0-py3-none-any.whl (6.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page