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 <https://github.com/adafruit/circuitpython>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-waveform/>`_. 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 <https://docs.circuitpython.org/projects/waveform/en/latest/>`_.
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_waveform/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-waveform",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, haptic, waveform, signal, audio, rtttl, sine, squarewave, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/a5/e2/0be40d3c6781c51d7856860aca31b3099c8bd2e9398573c6899e090884b7/adafruit_circuitpython_waveform-1.3.25.tar.gz",
"platform": null,
"description": "\nIntroduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-waveform/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/waveform/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Waveform/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_Waveform/actions/\n :alt: Build Status\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n :alt: Code Style: Ruff\n\nThis library generates simple waveforms that can be used to generate different\ntype of audio signals.\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n=====================\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-waveform/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-waveform\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-waveform\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-waveform\n\nUsage Example\n=============\n\nThis example generates one wavelength of a 440hz sine wave when played at 16 kilosamples per second:\n\n.. code-block:: python\n\n from adafruit_waveform import sine\n wave = sine.sine_wave(16000, 440)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/waveform/en/latest/>`_.\n\nFor information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_waveform/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for generating simple waveforms for audio.",
"version": "1.3.25",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_Waveform"
},
"split_keywords": [
"adafruit",
" haptic",
" waveform",
" signal",
" audio",
" rtttl",
" sine",
" squarewave",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f78a2245622dc17e93922a00d912341c8ca8cbbfd44b1e49296d561b6d232c5f",
"md5": "260778e98b55222d8fb5f835ad77169b",
"sha256": "a4b1c27af737e0cca297dfb8f0826fcee05b9818ee69bc55313d72dbf387181b"
},
"downloads": -1,
"filename": "adafruit_circuitpython_waveform-1.3.25-py3-none-any.whl",
"has_sig": false,
"md5_digest": "260778e98b55222d8fb5f835ad77169b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4832,
"upload_time": "2025-10-20T20:47:23",
"upload_time_iso_8601": "2025-10-20T20:47:23.060666Z",
"url": "https://files.pythonhosted.org/packages/f7/8a/2245622dc17e93922a00d912341c8ca8cbbfd44b1e49296d561b6d232c5f/adafruit_circuitpython_waveform-1.3.25-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a5e20be40d3c6781c51d7856860aca31b3099c8bd2e9398573c6899e090884b7",
"md5": "1459df181c3ec8e1ead0823cff097273",
"sha256": "c16ed6862ad7b0eb05de2059b6d54330fbc911c783ca700458c84ea2e06d6e5b"
},
"downloads": -1,
"filename": "adafruit_circuitpython_waveform-1.3.25.tar.gz",
"has_sig": false,
"md5_digest": "1459df181c3ec8e1ead0823cff097273",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 21913,
"upload_time": "2025-10-20T20:47:25",
"upload_time_iso_8601": "2025-10-20T20:47:25.860633Z",
"url": "https://files.pythonhosted.org/packages/a5/e2/0be40d3c6781c51d7856860aca31b3099c8bd2e9398573c6899e090884b7/adafruit_circuitpython_waveform-1.3.25.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-20 20:47:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_Waveform",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-waveform"
}
JSON
