Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-wm8960/badge/?version=latest
:target: https://docs.circuitpython.org/projects/wm8960/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_WM8960/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_WM8960/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
CircuitPython driver for WM8960 Stereo CODEC
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading `the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_ or individual libraries can be installed using `circup <https://github.com/adafruit/circup>`_.
This library is designed to help facilite the I2C connection with a WM8960 audio codec to configure it to be used for DAC, ADC, headphone and speaker functionality.
This library has been tested using an RP2040 on CircuitPython 9.1.1 and the `SparkFun Audio Codec PBreakout - WM8960 <https://www.sparkfun.com/products/21250>`_.
Installing from PyPI
=====================
.. note:: This library is not available on PyPI yet. Install documentation is included as a standard element. Stay tuned for PyPI availability!
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from PyPI <https://pypi.org/project/adafruit-circuitpython-wm8960/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-wm8960
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-wm8960
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install adafruit-circuitpython-wm8960
Installing to a Connected CircuitPython Device with Circup
==========================================================
Make sure that you have ``circup`` installed in your Python environment.
Install it with the following command if necessary:
.. code-block:: shell
pip3 install circup
With ``circup`` installed and your CircuitPython device connected use the
following command to install:
.. code-block:: shell
circup install adafruit_wm8960
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python
# Monitor Stereo Input: INPUT3 => Output Mixer => Headphones
import board
from adafruit_wm8960 import Input, WM8960
codec = WM8960(board.I2C())
codec.input = Input.LINE3
codec.gain = 0.5
codec.monitor = 1.0
codec.headphone = 0.5
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/wm8960/en/latest/>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct <https://github.com/adafruit/Adafruit_CircuitPython_WM8960/blob/HEAD/CODE_OF_CONDUCT.md>`_ before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-wm8960",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, codec, dac, adc, wm8960",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>, Cooper Dalrymple <me@dcdalrymple.com>",
"download_url": "https://files.pythonhosted.org/packages/a0/ce/2fd1a1f1d3c36ca3281038138c957eaddb440e524d67201a0fed03583774/adafruit_circuitpython_wm8960-1.0.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-wm8960/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/wm8960/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_WM8960/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_WM8960/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\nCircuitPython driver for WM8960 Stereo CODEC\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading `the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_ or individual libraries can be installed using `circup <https://github.com/adafruit/circup>`_.\n\nThis library is designed to help facilite the I2C connection with a WM8960 audio codec to configure it to be used for DAC, ADC, headphone and speaker functionality.\n\nThis library has been tested using an RP2040 on CircuitPython 9.1.1 and the `SparkFun Audio Codec PBreakout - WM8960 <https://www.sparkfun.com/products/21250>`_.\n\nInstalling from PyPI\n=====================\n.. note:: This library is not available on PyPI yet. Install documentation is included as a standard element. Stay tuned for PyPI availability!\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from PyPI <https://pypi.org/project/adafruit-circuitpython-wm8960/>`_.\n\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-wm8960\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-wm8960\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 .env/bin/activate\n pip3 install adafruit-circuitpython-wm8960\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install adafruit_wm8960\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\n.. code-block:: python\n\n # Monitor Stereo Input: INPUT3 => Output Mixer => Headphones\n import board\n from adafruit_wm8960 import Input, WM8960\n codec = WM8960(board.I2C())\n codec.input = Input.LINE3\n codec.gain = 0.5\n codec.monitor = 1.0\n codec.headphone = 0.5\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/wm8960/en/latest/>`_.\n\nContributing\n============\nContributions are welcome! Please read our `Code of Conduct <https://github.com/adafruit/Adafruit_CircuitPython_WM8960/blob/HEAD/CODE_OF_CONDUCT.md>`_ before contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython driver for WM8960 Stereo CODEC",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_WM8960"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" codec",
" dac",
" adc",
" wm8960"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2ffc75f4188302e1d1b93c60f76ff213ba5488207ac2b266afb762a0c2ca5634",
"md5": "b965e36f7ef66e20892320d62f3ce1e0",
"sha256": "50cbf60aeeac5c54629d1181a7fbc23ca6475658809f0c43f3d95d78a2a8cffd"
},
"downloads": -1,
"filename": "adafruit_circuitpython_wm8960-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b965e36f7ef66e20892320d62f3ce1e0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 20669,
"upload_time": "2024-11-05T15:02:39",
"upload_time_iso_8601": "2024-11-05T15:02:39.196506Z",
"url": "https://files.pythonhosted.org/packages/2f/fc/75f4188302e1d1b93c60f76ff213ba5488207ac2b266afb762a0c2ca5634/adafruit_circuitpython_wm8960-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a0ce2fd1a1f1d3c36ca3281038138c957eaddb440e524d67201a0fed03583774",
"md5": "7baaf711e7cb9915961bacb1343d3fa8",
"sha256": "0bcc4310583fbc3a928c96aa5bb80ce64646c8e4664f03b3a1d66c2b8cb55c0a"
},
"downloads": -1,
"filename": "adafruit_circuitpython_wm8960-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "7baaf711e7cb9915961bacb1343d3fa8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 43795,
"upload_time": "2024-11-05T15:02:40",
"upload_time_iso_8601": "2024-11-05T15:02:40.811843Z",
"url": "https://files.pythonhosted.org/packages/a0/ce/2fd1a1f1d3c36ca3281038138c957eaddb440e524d67201a0fed03583774/adafruit_circuitpython_wm8960-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-05 15:02:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_WM8960",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "adafruit-circuitpython-busdevice",
"specs": []
},
{
"name": "adafruit-circuitpython-simplemath",
"specs": []
}
],
"lcname": "adafruit-circuitpython-wm8960"
}
JSON
