pibeep


Namepibeep JSON
Version 0.0.1.5 PyPI version JSON
download
home_pagehttps://github.com/Tsangares/beep
SummaryBuzzer utility for pi
upload_time2020-11-28 02:03:02
maintainer
docs_urlNone
author
requires_python>=3.7
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ## Context

This tool is showcased in the project [IotaWorkshop](https://github.com/Tsangares/iotaworkshop)

# Summary

This is a beeping utility for the common buzzer. This package comes with a variety of beeps that can be called from a command line inteface or imported from python.

# Installation

This package requires `RPi.GPIO`, which I installed on arch arm using

    yay -S python-raspberry-gpio
	
But ubuntu or rasbian can use,

    pip install RPi.GPIO

To install pibeep simply install the pip package.

    pip install pibeep
	
You can then look at the examples on how to run as a cli. You can also import it into your project using,

	from pibeep import pulseBeep,beepDuration
	beepDuration(pin=12,duration=.33) #beeper on pin 12, on for .33 sec
	pulseBeep(pin=12,freq=25,duration=1) #pulse beep at 25HZ for 1 seccond


# Beeps

 - short: duration 0.05 sec
 - medium: duration 0.25 sec
 - long: duration 1.00 sec
 - warning: pulses 8HZ for 1.5 sec duration
 - confirmed: pulses 16HZ for .5 sec duration
 - brr: pulses 50HZ for .5 sec duration
 
# Example

The cli can be use any of the listed above beeps in the format as the following commands:

    beep warning --pin 12 #Warning sound
    beep short --pin 12 #Small beep
	beep brr --pin 12 #A rumbling sound
	beep confirmed --pin 12 #A sound that conveys success

Usually I need to run it as sudo to have the correct permissions, but it depends on your setup.
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Tsangares/beep",
    "name": "pibeep",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "",
    "author": "",
    "author_email": "william.wyatt@cgu.edu",
    "download_url": "https://files.pythonhosted.org/packages/41/29/ad4d62cf3c38c314493c6fca60761a296d163dd855dcd37d60cf32ef863a/pibeep-0.0.1.5.tar.gz",
    "platform": "",
    "description": "## Context\n\nThis tool is showcased in the project [IotaWorkshop](https://github.com/Tsangares/iotaworkshop)\n\n# Summary\n\nThis is a beeping utility for the common buzzer. This package comes with a variety of beeps that can be called from a command line inteface or imported from python.\n\n# Installation\n\nThis package requires `RPi.GPIO`, which I installed on arch arm using\n\n    yay -S python-raspberry-gpio\n\t\nBut ubuntu or rasbian can use,\n\n    pip install RPi.GPIO\n\nTo install pibeep simply install the pip package.\n\n    pip install pibeep\n\t\nYou can then look at the examples on how to run as a cli. You can also import it into your project using,\n\n\tfrom pibeep import pulseBeep,beepDuration\n\tbeepDuration(pin=12,duration=.33) #beeper on pin 12, on for .33 sec\n\tpulseBeep(pin=12,freq=25,duration=1) #pulse beep at 25HZ for 1 seccond\n\n\n# Beeps\n\n - short: duration 0.05 sec\n - medium: duration 0.25 sec\n - long: duration 1.00 sec\n - warning: pulses 8HZ for 1.5 sec duration\n - confirmed: pulses 16HZ for .5 sec duration\n - brr: pulses 50HZ for .5 sec duration\n \n# Example\n\nThe cli can be use any of the listed above beeps in the format as the following commands:\n\n    beep warning --pin 12 #Warning sound\n    beep short --pin 12 #Small beep\n\tbeep brr --pin 12 #A rumbling sound\n\tbeep confirmed --pin 12 #A sound that conveys success\n\nUsually I need to run it as sudo to have the correct permissions, but it depends on your setup.",
    "bugtrack_url": null,
    "license": "",
    "summary": "Buzzer utility for pi",
    "version": "0.0.1.5",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "58b66417ab5439a9f34948191135399e",
                "sha256": "d061243f60812f1a5ed0f9e204a86bc6154b154cc1805bbac3b0be769c9cacc6"
            },
            "downloads": -1,
            "filename": "pibeep-0.0.1.5.tar.gz",
            "has_sig": false,
            "md5_digest": "58b66417ab5439a9f34948191135399e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 2815,
            "upload_time": "2020-11-28T02:03:02",
            "upload_time_iso_8601": "2020-11-28T02:03:02.428522Z",
            "url": "https://files.pythonhosted.org/packages/41/29/ad4d62cf3c38c314493c6fca60761a296d163dd855dcd37d60cf32ef863a/pibeep-0.0.1.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2020-11-28 02:03:02",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "Tsangares",
    "error": "Could not fetch GitHub repository",
    "lcname": "pibeep"
}
        
Elapsed time: 0.16165s