https://github.com/nikhiljohn10/pi-clap

A python package for clap detection
https://github.com/nikhiljohn10/pi-clap

gpio linux macos package pi-clap pyaudio python3 raspberrypi raspbian-os

Last synced: 12 months ago
JSON representation

A python package for clap detection

• Host: GitHub
• URL: https://github.com/nikhiljohn10/pi-clap
• Owner: nikhiljohn10
• License: mit
• Created: 2014-10-31T12:39:46.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2021-10-06T19:31:23.000Z (over 4 years ago)
• Last Synced: 2025-05-29T19:03:57.160Z (about 1 year ago)
• Topics: gpio, linux, macos, package, pi-clap, pyaudio, python3, raspberrypi, raspbian-os
• Language: Python
• Homepage: https://pi-clap.nikz.in
• Size: 18.8 MB
• Stars: 78
• Watchers: 4
• Forks: 22
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
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/)

[![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

Visit Official documentation at [pi-clap.nikz.in](https://pi-clap.nikz.in/)

### Platforms Supported

* Raspberry Pi

* Linux

* MacOS

### Hardware Requirements

* Raspberry Pi (optional)

* Bread Board (optional)

* Microphone

* Audio Card (Needed for analog microphones with a jack)

### Dependencies

* [Python 3.6+](https://docs.python.org/3/)

* [gpiozero](https://gpiozero.readthedocs.io)

	* [RPi.GPIO](https://pypi.org/project/RPi.GPIO)

* [PyAudio](https://pypi.org/project/PyAudio)

	* [PortAudio](http://www.portaudio.com/) (Need to be installed manually)

	* Audio Driver (Automatically loaded by OS after a restart)

* [Munch](https://pypi.org/project/munch/)

### Upcoming features

* Adding advanced clap detection algorithms

* Adding support for automation platforms like Amazon Alexa, Google Home, IFTTT etc.

### Development

```

git clone https://github.com/nikhiljohn10/pi-clap

cd pi-clap

make help # Display the possible options available

```

Version number is fetched from [`piclap/__init__.py`](https://github.com/nikhiljohn10/pi-clap/blob/master/piclap/__init__.py)

- Package - [/piclap](https://github.com/nikhiljohn10/pi-clap/tree/master/piclap)

- Examples - [/example](https://github.com/nikhiljohn10/pi-clap/tree/master/example)

- Documentation - [/docs/source](https://github.com/nikhiljohn10/pi-clap/tree/master/docs/source)

- Test Cases - [/test](https://github.com/nikhiljohn10/pi-clap/tree/master/tests)

- Github Actions - [/.github/workflows](https://github.com/nikhiljohn10/pi-clap/tree/master/.github/workflows)

### License

[MIT License](https://github.com/nikhiljohn10/pi-clap/blob/master/LICENSE)