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.23.tar.gz (27.3 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit_circuitpython_rtttl-2.4.23.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_rtttl-2.4.23.tar.gz
Algorithm Hash digest
SHA256 6ce50066829268b19d5a60a3faf9ce32bf5c2c72ee3cefcefcdbb8efb3c08cd0
MD5 98979697f295edb337169b16eb9ed76b
BLAKE2b-256 d72546957dcc4d5062b4e737d2112ed9a98742434aa645a7caef97ee953268f2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_rtttl-2.4.23-py3-none-any.whl
Algorithm Hash digest
SHA256 5887dac0967acbd4bc5d874724f0d1d1bfaa455a46d70f63d14fa7b1ead6c0eb
MD5 b95162c8f3649b7abbd7b1379c8e8265
BLAKE2b-256 1834312e449b8042f274d890933e87727e21f5335f0655f49ffac4a8056f0cbb

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