Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-bd3491fs/badge/?version=latest
:target: https://docs.circuitpython.org/projects/bd3491fs/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_BD3491FS/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_BD3491FS/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 library for the Rohm BD3491FS Audio Processor
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_
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-bd3491fs/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-bd3491fs
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-bd3491fs
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-bd3491fs
Usage Example
=============
.. code-block:: python
import board
import adafruit_bd3491fs
import busio
i2c = busio.I2C(board.SCL, board.SDA)
bd3491fs = adafruit_bd3491fs.BD3491FS(i2c)
bd3491fs.active_input = adafruit_bd3491fs.Input.A
bd3491fs.input_gain = adafruit_bd3491fs.Level.LEVEL_20DB
bd3491fs.channel_1_attenuation = 0
bd3491fs.channel_2_attenuation = 0
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/bd3491fs/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_BD3491FS/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-bd3491fs",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,bd3491fs,audio",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/83/84/359a8d08bcf05f71ed245caac04b9cc78945a4e4fc239bb2dee07513e03d/adafruit-circuitpython-bd3491fs-1.1.16.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-bd3491fs/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/bd3491fs/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_BD3491FS/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_BD3491FS/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 library for the Rohm BD3491FS Audio Processor\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* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_\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-bd3491fs/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-bd3491fs\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-bd3491fs\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-bd3491fs\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import board\n import adafruit_bd3491fs\n import busio\n\n i2c = busio.I2C(board.SCL, board.SDA)\n bd3491fs = adafruit_bd3491fs.BD3491FS(i2c)\n\n bd3491fs.active_input = adafruit_bd3491fs.Input.A\n bd3491fs.input_gain = adafruit_bd3491fs.Level.LEVEL_20DB\n bd3491fs.channel_1_attenuation = 0\n bd3491fs.channel_2_attenuation = 0\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/bd3491fs/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_BD3491FS/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for the Rohm BD3491FS Audio Processor",
"version": "1.1.16",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_BD3491FS"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"bd3491fs",
"audio"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6fd8f5254b568f703a64a702cc786710cde93d6ebcb2ddb592a24399833ca3cb",
"md5": "a1d7e94e25c87083933e392945c98c56",
"sha256": "7727da86bbf83397afd7aee5a7728bce95112cbac9da2180f59003dd5797255d"
},
"downloads": -1,
"filename": "adafruit_circuitpython_bd3491fs-1.1.16-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a1d7e94e25c87083933e392945c98c56",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5480,
"upload_time": "2023-09-25T15:36:50",
"upload_time_iso_8601": "2023-09-25T15:36:50.099549Z",
"url": "https://files.pythonhosted.org/packages/6f/d8/f5254b568f703a64a702cc786710cde93d6ebcb2ddb592a24399833ca3cb/adafruit_circuitpython_bd3491fs-1.1.16-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8384359a8d08bcf05f71ed245caac04b9cc78945a4e4fc239bb2dee07513e03d",
"md5": "15995317007fc266f77811549ddf29d3",
"sha256": "5f0ab9ced2c2786836dd1085108b76f25ddfc11c681099d33ffe69add03dbf09"
},
"downloads": -1,
"filename": "adafruit-circuitpython-bd3491fs-1.1.16.tar.gz",
"has_sig": false,
"md5_digest": "15995317007fc266f77811549ddf29d3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 26331,
"upload_time": "2023-09-25T15:36:51",
"upload_time_iso_8601": "2023-09-25T15:36:51.614569Z",
"url": "https://files.pythonhosted.org/packages/83/84/359a8d08bcf05f71ed245caac04b9cc78945a4e4fc239bb2dee07513e03d/adafruit-circuitpython-bd3491fs-1.1.16.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-25 15:36:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_BD3491FS",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-bd3491fs"
}
JSON
