Skip to main content

CircuitPython library for playing RTTTL melodies.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

adafruit_circuitpython_rtttl-2.4.29-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_rtttl-2.4.29.tar.gz
Algorithm Hash digest
SHA256 7e4021741ba5008060596cb753d4051f53d80c58e1c934d603aab31cb758b4b5
MD5 a99dbecaf22991f9dbc88709db03f712
BLAKE2b-256 dfa7aff63ebe5df51c333f4e7ba900b90b45c1194df00a6edc7fdef80d013a90

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_rtttl-2.4.29-py3-none-any.whl
Algorithm Hash digest
SHA256 81a616a28773ffc7b8b2a3cd13a7f5be785e0651a55fff35097c65aec02829c5
MD5 0eb91b1e9a783344208f89e580bdc424
BLAKE2b-256 c26ebc1700a9ca5d4e79be72350002abc3335c65b1312cc60d638fcf79d4089b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page