adafruit-circuitpython-tlv320


Nameadafruit-circuitpython-tlv320 JSON
Version 1.2.2 PyPI version JSON
download
home_pageNone
SummaryCircuitPython driver for the TLV320DAC3100 I2S DAC
upload_time2025-09-06 10:22:49
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseMIT
keywords adafruit blinka circuitpython micropython tlv320 i2s dac tlv320dac3100
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-tlv320/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/tlv320/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_TLV320/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_TLV320/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 TLV320DAC3100 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>`_.

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

.. code-block:: shell

    pip3 install adafruit-circuitpython-tlv320

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-tlv320

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

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_tlv320

Or the following command to update an existing version:

.. code-block:: shell

    circup update

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

.. code-block:: python

	import audiobusio
	import audiocore
	import board
	import digitalio

	import adafruit_tlv320

	# Reset the DAC before use
	reset_pin = digitalio.DigitalInOut(board.D12)
	reset_pin.direction = digitalio.Direction.OUTPUT
	reset_pin.value = False  # Set low to reset
	time.sleep(0.1)  # Pause 100ms
	reset_pin.value = True  # Set high to release from reset

	i2c = board.I2C()
	dac = adafruit_tlv320.TLV320DAC3100(i2c)

	# set mclk, sample rate & bit depth
	dac.configure_clocks(sample_rate=44100, bit_depth=16)

	# use headphones
	# helper function for default settings
	dac.headphone_output = True
	dac.dac_volume = -20  # dB

	audio = audiobusio.I2SOut(board.I2S_BCLK, board.I2S_WS, board.I2S_DIN)

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

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "adafruit-circuitpython-tlv320",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "adafruit, blinka, circuitpython, micropython, tlv320, I2S, , DAC, , TLV320DAC3100",
    "author": null,
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/20/e4/2afd3037cef4d79ccbacef949402c5f2b72bc77af1cdb653544e54d98ca1/adafruit_circuitpython_tlv320-1.2.2.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-tlv320/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/tlv320/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_TLV320/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_TLV320/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 TLV320DAC3100 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\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-tlv320/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-tlv320\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-tlv320\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-tlv320\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_tlv320\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 audiobusio\n\timport audiocore\n\timport board\n\timport digitalio\n\n\timport adafruit_tlv320\n\n\t# Reset the DAC before use\n\treset_pin = digitalio.DigitalInOut(board.D12)\n\treset_pin.direction = digitalio.Direction.OUTPUT\n\treset_pin.value = False  # Set low to reset\n\ttime.sleep(0.1)  # Pause 100ms\n\treset_pin.value = True  # Set high to release from reset\n\n\ti2c = board.I2C()\n\tdac = adafruit_tlv320.TLV320DAC3100(i2c)\n\n\t# set mclk, sample rate & bit depth\n\tdac.configure_clocks(sample_rate=44100, bit_depth=16)\n\n\t# use headphones\n\t# helper function for default settings\n\tdac.headphone_output = True\n\tdac.dac_volume = -20  # dB\n\n\taudio = audiobusio.I2SOut(board.I2S_BCLK, board.I2S_WS, board.I2S_DIN)\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/tlv320/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_TLV320/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 TLV320DAC3100 I2S DAC",
    "version": "1.2.2",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_TLV320"
    },
    "split_keywords": [
        "adafruit",
        " blinka",
        " circuitpython",
        " micropython",
        " tlv320",
        " i2s",
        " ",
        " dac",
        " ",
        " tlv320dac3100"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "4570b42befc3753ea93b346155113a5cd5567e36be0956a4251832932b6b7f9b",
                "md5": "3bb9f2cf936f4af0f11596ab4d7d6f7f",
                "sha256": "8619445604bd502a6fe3bafed66d78cc38519409554e55e33cdf492e497d3505"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_tlv320-1.2.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3bb9f2cf936f4af0f11596ab4d7d6f7f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 19517,
            "upload_time": "2025-09-06T10:22:47",
            "upload_time_iso_8601": "2025-09-06T10:22:47.476649Z",
            "url": "https://files.pythonhosted.org/packages/45/70/b42befc3753ea93b346155113a5cd5567e36be0956a4251832932b6b7f9b/adafruit_circuitpython_tlv320-1.2.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "20e42afd3037cef4d79ccbacef949402c5f2b72bc77af1cdb653544e54d98ca1",
                "md5": "1f26f7909f2adf35800311364bed6f98",
                "sha256": "25e2d8de0f9681077475bddf11e498dfcd2a6a08fffaf487ca529bae5d1ca947"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_tlv320-1.2.2.tar.gz",
            "has_sig": false,
            "md5_digest": "1f26f7909f2adf35800311364bed6f98",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 42015,
            "upload_time": "2025-09-06T10:22:49",
            "upload_time_iso_8601": "2025-09-06T10:22:49.942763Z",
            "url": "https://files.pythonhosted.org/packages/20/e4/2afd3037cef4d79ccbacef949402c5f2b72bc77af1cdb653544e54d98ca1/adafruit_circuitpython_tlv320-1.2.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-09-06 10:22:49",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_TLV320",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "Adafruit-Blinka",
            "specs": []
        },
        {
            "name": "adafruit-circuitpython-busdevice",
            "specs": []
        }
    ],
    "lcname": "adafruit-circuitpython-tlv320"
}
        
Elapsed time: 1.53528s