adafruit-circuitpython-pcm51xx


Nameadafruit-circuitpython-pcm51xx JSON
Version 1.0.1 PyPI version JSON
download
home_pageNone
SummaryCircuitPython driver for the Adafruit PCM51xx I2S DAC
upload_time2025-10-20 21:47:28
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseMIT
keywords adafruit blinka circuitpython micropython pcm51xx i2s dac pcm5122
VCS
bugtrack_url
requirements Adafruit-Blinka adafruit-circuitpython-busdevice
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============


.. image:: https://readthedocs.org/projects/adafruit-circuitpython-pcm51xx/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/pcm51xx/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_PCM51xx/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_PCM51xx/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

CircuitPython driver for the Adafruit PCM51xx I2S DAC


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>`_.

`Purchase one from the Adafruit shop <http://www.adafruit.com/products/6421>`_

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-pcm51xx/>`_.
To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-pcm51xx

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-pcm51xx

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-pcm51xx

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_pcm51xx

Or the following command to update an existing version:

.. code-block:: shell

    circup update

Usage Example
=============

.. code-block:: python

	import board
	import busio
	import adafruit_pcm51xx

	i2c = board.I2C()

	pcm = adafruit_pcm51xx.PCM51XX(i2c)

	pcm.volume_db = (0.0, 0.0)
	left_db, right_db = pcm.volume_db
	print(f"Volume set to: L={left_db}dB, R={right_db}dB")

	pcm.mute = False
	print(f"Muted: {pcm.mute}")

Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/pcm51xx/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_PCM51xx/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "adafruit-circuitpython-pcm51xx",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "adafruit, blinka, circuitpython, micropython, pcm51xx, I2S, DAC, , PCM5122",
    "author": null,
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/55/43/7e7acf2ed1079af08c7579cf1e22c65879b6551053039ce7344577f26560/adafruit_circuitpython_pcm51xx-1.0.1.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-pcm51xx/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/pcm51xx/en/latest/\n    :alt: Documentation Status\n\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\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_PCM51xx/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_PCM51xx/actions\n    :alt: Build Status\n\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\nCircuitPython driver for the Adafruit PCM51xx I2S DAC\n\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\n`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\n`Purchase one from the Adafruit shop <http://www.adafruit.com/products/6421>`_\n\nInstalling from PyPI\n=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-pcm51xx/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-pcm51xx\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-pcm51xx\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-pcm51xx\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_pcm51xx\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\timport board\n\timport busio\n\timport adafruit_pcm51xx\n\n\ti2c = board.I2C()\n\n\tpcm = adafruit_pcm51xx.PCM51XX(i2c)\n\n\tpcm.volume_db = (0.0, 0.0)\n\tleft_db, right_db = pcm.volume_db\n\tprint(f\"Volume set to: L={left_db}dB, R={right_db}dB\")\n\n\tpcm.mute = False\n\tprint(f\"Muted: {pcm.mute}\")\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/pcm51xx/en/latest/>`_.\n\nFor information on building library documentation, please check out\n`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_PCM51xx/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "CircuitPython driver for the Adafruit PCM51xx I2S DAC",
    "version": "1.0.1",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_PCM51xx"
    },
    "split_keywords": [
        "adafruit",
        " blinka",
        " circuitpython",
        " micropython",
        " pcm51xx",
        " i2s",
        " dac",
        " ",
        " pcm5122"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "98592a7349c2c6c30cd030b0f2468108b21ea5eb1aeeacfa395cf925431624a3",
                "md5": "6f166b272234e8a67ea15323c7fe238e",
                "sha256": "d914b642a8d0933a23d93e783c8e02a89e1e8376f38cea4715e373ee17754fd9"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_pcm51xx-1.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6f166b272234e8a67ea15323c7fe238e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 8410,
            "upload_time": "2025-10-20T21:47:27",
            "upload_time_iso_8601": "2025-10-20T21:47:27.861796Z",
            "url": "https://files.pythonhosted.org/packages/98/59/2a7349c2c6c30cd030b0f2468108b21ea5eb1aeeacfa395cf925431624a3/adafruit_circuitpython_pcm51xx-1.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "55437e7acf2ed1079af08c7579cf1e22c65879b6551053039ce7344577f26560",
                "md5": "68cb0fad01e21dfff8f33dfd9485cbb7",
                "sha256": "c095bb1d688b35f31de0c2463fda56d9840214d395d2f54c65efd5a540f3228c"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_pcm51xx-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "68cb0fad01e21dfff8f33dfd9485cbb7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 28789,
            "upload_time": "2025-10-20T21:47:28",
            "upload_time_iso_8601": "2025-10-20T21:47:28.628938Z",
            "url": "https://files.pythonhosted.org/packages/55/43/7e7acf2ed1079af08c7579cf1e22c65879b6551053039ce7344577f26560/adafruit_circuitpython_pcm51xx-1.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-10-20 21:47:28",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_PCM51xx",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "Adafruit-Blinka",
            "specs": []
        },
        {
            "name": "adafruit-circuitpython-busdevice",
            "specs": []
        }
    ],
    "lcname": "adafruit-circuitpython-pcm51xx"
}
        
Elapsed time: 2.32391s