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/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
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/07/b8/f0cb858b92aa712db9447d1b7e130da2330050909cfcc5b7905e65775e26/adafruit_circuitpython_waveform-1.3.21.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/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\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.21",
"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": "",
"digests": {
"blake2b_256": "14d633c778970a9bfe5d0b5b51c4417caff3f7356b2531916b5d7731b179e332",
"md5": "e9bba4117a511ef71bc5d45262681194",
"sha256": "445c267041a9442d393177eff55ce30e0930a46303020b9bab9ee0b788210e85"
},
"downloads": -1,
"filename": "adafruit_circuitpython_waveform-1.3.21-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e9bba4117a511ef71bc5d45262681194",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4771,
"upload_time": "2024-10-07T22:35:26",
"upload_time_iso_8601": "2024-10-07T22:35:26.371877Z",
"url": "https://files.pythonhosted.org/packages/14/d6/33c778970a9bfe5d0b5b51c4417caff3f7356b2531916b5d7731b179e332/adafruit_circuitpython_waveform-1.3.21-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "07b8f0cb858b92aa712db9447d1b7e130da2330050909cfcc5b7905e65775e26",
"md5": "f3181d9524156f60f84242f204779115",
"sha256": "1448f095f1a70f625c0437b59003340531187ba25a9d7cbc516f070836c6e9f6"
},
"downloads": -1,
"filename": "adafruit_circuitpython_waveform-1.3.21.tar.gz",
"has_sig": false,
"md5_digest": "f3181d9524156f60f84242f204779115",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 25011,
"upload_time": "2024-10-07T22:35:27",
"upload_time_iso_8601": "2024-10-07T22:35:27.418080Z",
"url": "https://files.pythonhosted.org/packages/07/b8/f0cb858b92aa712db9447d1b7e130da2330050909cfcc5b7905e65775e26/adafruit_circuitpython_waveform-1.3.21.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 22:35:27",
"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
