Skip to main content

CircuitPython library for playing RTTTL melodies.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

This plays RTTTL melodies.

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

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 adafruit-circuitpython-rtttl

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

sudo pip3 install adafruit-circuitpython-rtttl

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-rtttl

Usage Example

This plays Frosty the Snowman:

import board
import adafruit_rtttl

adafruit_rtttl.play(board.A0, "Snowman:d=8,o=5,b=200:2g,4e.,f,4g,2c6,b,c6,4d6,4c6,4b,a,2g.,b,c6,4d6,4c6,4b,a,a,g,4c6,4e.,g,a,4g,4f,4e,4d,2c.,4c,4a,4a,4c6,4c6,4b,4a,4g,4e,4f,4a,4g,4f,2e.,4e,4d,4d,4g,4g,4b,4b,4d6,d6,b,4d6,4c6,4b,4a,4g,4p,2g")

CPX Usage Example

This plays Frosty the Snowman on a Circuit Playground Express (we must enable onboard speaker):

import board
from digitalio import DigitalInOut, Direction
import adafruit_rtttl
spkrenable = DigitalInOut(board.SPEAKER_ENABLE)
spkrenable.direction = Direction.OUTPUT
spkrenable.value = True

adafruit_rtttl.play(board.A0, "Snowman:d=8,o=5,b=200:2g,4e.,f,4g,2c6,b,c6,4d6,4c6,4b,a,2g.,b,c6,4d6,4c6,4b,a,a,g,4c6,4e.,g,a,4g,4f,4e,4d,2c.,4c,4a,4a,4c6,4c6,4b,4a,4g,4e,4f,4a,4g,4f,2e.,4e,4d,4d,4g,4g,4b,4b,4d6,d6,b,4d6,4c6,4b,4a,4g,4p,2g")

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.

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

adafruit-circuitpython-rtttl-2.4.17.tar.gz (28.9 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit-circuitpython-rtttl-2.4.17.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-rtttl-2.4.17.tar.gz
Algorithm Hash digest
SHA256 160653e7cc25cca43ee96e645d979014d9bd355294925af62a55efdabb676cf8
MD5 2a34c6c5ae2a2b71cea5b310ac824f44
BLAKE2b-256 03ec1f5ed5a4920fff13585dcc208518647b6816bdea67452c324c9739cd6dc7

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_rtttl-2.4.17-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_rtttl-2.4.17-py3-none-any.whl
Algorithm Hash digest
SHA256 c331f518e095698d0727a7dbcf2da7eb8f058b61088389fea7700141a89cf2bc
MD5 60fce60cad76e79324985e6f3ac3261b
BLAKE2b-256 41b0740fd832d32560e9eabb48baab01c3e8b91c1a49274b658513b67489d775

See more details on using hashes here.

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