https://github.com/adafruit/adafruit_circuitpython_waveform
CircuitPython library to generate single wavelength waveforms.
https://github.com/adafruit/adafruit_circuitpython_waveform
audio circuitpython hacktoberfest sound waveform
Last synced: 3 months ago
JSON representation
CircuitPython library to generate single wavelength waveforms.
- Host: GitHub
- URL: https://github.com/adafruit/adafruit_circuitpython_waveform
- Owner: adafruit
- License: mit
- Created: 2017-05-04T18:30:44.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2025-01-16T20:06:15.000Z (about 1 year ago)
- Last Synced: 2025-01-28T22:37:39.175Z (12 months ago)
- Topics: audio, circuitpython, hacktoberfest, sound, waveform
- Language: Python
- Size: 104 KB
- Stars: 7
- Watchers: 18
- Forks: 13
- Open Issues: 0
-
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-waveform/badge/?version=latest
:target: https://docs.circuitpython.org/projects/waveform/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_Waveform/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_Waveform/actions/
:alt: Build Status
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:target: https://github.com/astral-sh/ruff
:alt: Code Style: Ruff
This library generates simple waveforms that can be used to generate different
type of audio signals.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython `_
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-waveform
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-waveform
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-waveform
Usage Example
=============
This example generates one wavelength of a 440hz sine wave when played at 16 kilosamples per second:
.. code-block:: python
from adafruit_waveform import sine
wave = sine.sine_wave(16000, 440)
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.