Introduction

Play simple tunes on a piezo buzzer asynchronously

Dependencies

This driver depends on:

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install circuitpython-async-buzzer

To install system-wide (this may be required in some cases):

sudo pip3 install circuitpython-async-buzzer

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install circuitpython-async-buzzer

Installing to a Connected CircuitPython Device with Circup

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install async_buzzer

Or the following command to update an existing version:

circup update

Usage Example

import asyncio

import pwmio

from async_buzzer import Buzzer
import board

tune = [
    ("E5",500),
    ("G5",500),
    ("A5",1000),
    ("E5",500),
    ("G5",500),
    ("B5",250),
    ("A5",750),
    ("E5",500),
    ("G5",500),
    ("A5",1000),
    ("G5",500),
    ("E5",1500)
]

pwm = pwmio.PWMOut(board.D10, variable_frequency=True)
buzzer = Buzzer(pwm)


async def main():
    buzzer.play(tune, wait=False)
    for i in range(5):
        print(i)
        await asyncio.sleep(1)
    await buzzer.wait()

asyncio.run(main())

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Table of Contents

Examples

Simple test

API Reference