https://github.com/adafruit/adafruit_circuitpython_rtttl

Play RTTTL tunes in CircuitPython
https://github.com/adafruit/adafruit_circuitpython_rtttl

audio circuitpython hacktoberfest music ringtone rtttl sound

Last synced: 3 months ago
JSON representation

Play RTTTL tunes in CircuitPython

• Host: GitHub
• URL: https://github.com/adafruit/adafruit_circuitpython_rtttl
• Owner: adafruit
• License: mit
• Created: 2017-05-04T18:43:13.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2023-12-09T17:53:18.000Z (about 1 year ago)
• Last Synced: 2024-10-07T11:10:33.702Z (3 months ago)
• Topics: audio, circuitpython, hacktoberfest, music, ringtone, rtttl, sound
• Language: Python
• Size: 125 KB
• Stars: 4
• Watchers: 20
• Forks: 12
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        

Introduction

============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-rtttl/badge/?version=latest

    :target: https://docs.circuitpython.org/projects/rtttl/en/latest/

    :alt: Documentation Status

.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg

    :target: https://adafru.it/discord

    :alt: Discord

.. image:: https://github.com/adafruit/Adafruit_CircuitPython_RTTTL/workflows/Build%20CI/badge.svg

    :target: https://github.com/adafruit/Adafruit_CircuitPython_RTTTL/actions/

    :alt: Build Status

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg

    :target: https://github.com/psf/black

    :alt: Code Style: Black

This plays `RTTTL `_ melodies.

Dependencies

=============

This driver depends on:

* `Adafruit CircuitPython `_

* `Adafruit CircuitPython Waveform `_

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:

.. code-block:: shell

    pip3 install adafruit-circuitpython-rtttl

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-rtttl

To install in a virtual environment in your current project:

.. code-block:: shell

    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:

.. code-block:: python

    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):

.. code-block:: python

    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.