Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-vs1053/badge/?version=latest
:target: https://docs.circuitpython.org/projects/vs1053/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_VS1053/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_VS1053/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
Driver for interacting and playing media files with the VS1053 audio codec over
a SPI connection.
NOTE: This is not currently working for audio playback of files. Only sine
wave test currently works. The problem is that pure Python code is currently
too slow to keep up with feeding data to the VS1053 fast enough. There's no
interrupt support so Python code has to monitor the DREQ line and provide a
small buffer of data when ready, but the overhead of the interpreter means we
can't keep up. Optimizing SPI to use DMA transfers could help but ultimately
an interrupt-based approach is likely what can make this work better (or C
functions built in to custom builds that monitor the DREQ line and feed a
buffer of data).
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://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-vs1053/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-vs1053
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-vs1053
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-vs1053
Usage Example
=============
See examples/sdfile_play.py.
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/vs1053/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_VS1053/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-vs1053",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,audio,codec,vs1053,spi,hardware,micropython,circuitpython",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/90/ea/8350e005d8569581a7aef5bbc6ad737afcb5d144efe89483ed0d98169f4e/adafruit-circuitpython-vs1053-1.2.18.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-vs1053/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/vs1053/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_VS1053/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_VS1053/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\nDriver for interacting and playing media files with the VS1053 audio codec over\na SPI connection.\n\nNOTE: This is not currently working for audio playback of files. Only sine\nwave test currently works. The problem is that pure Python code is currently\ntoo slow to keep up with feeding data to the VS1053 fast enough. There's no\ninterrupt support so Python code has to monitor the DREQ line and provide a\nsmall buffer of data when ready, but the overhead of the interpreter means we\ncan't keep up. Optimizing SPI to use DMA transfers could help but ultimately\nan interrupt-based approach is likely what can make this work better (or C\nfunctions built in to custom builds that monitor the DREQ line and feed a\nbuffer of data).\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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\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-vs1053/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-vs1053\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-vs1053\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-vs1053\n\nUsage Example\n=============\n\nSee examples/sdfile_play.py.\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/vs1053/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_VS1053/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Driver for interacting and playing media files with the VS1053 audio codec over a SPI connection.",
"version": "1.2.18",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_VS1053"
},
"split_keywords": [
"adafruit",
"audio",
"codec",
"vs1053",
"spi",
"hardware",
"micropython",
"circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2d39bdc495b2f227c3864d4608b2916424df293f2f36d23e345e09a063db1c84",
"md5": "07ae6eb99da750ed8c564e3b32354ceb",
"sha256": "c53e0600ce7f0217c34ff59924564268ee5acad58d4035adcf46233fda0eb8c6"
},
"downloads": -1,
"filename": "adafruit_circuitpython_vs1053-1.2.18-py3-none-any.whl",
"has_sig": false,
"md5_digest": "07ae6eb99da750ed8c564e3b32354ceb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6939,
"upload_time": "2023-12-09T17:36:50",
"upload_time_iso_8601": "2023-12-09T17:36:50.846601Z",
"url": "https://files.pythonhosted.org/packages/2d/39/bdc495b2f227c3864d4608b2916424df293f2f36d23e345e09a063db1c84/adafruit_circuitpython_vs1053-1.2.18-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "90ea8350e005d8569581a7aef5bbc6ad737afcb5d144efe89483ed0d98169f4e",
"md5": "db549a5dec4319f17f498b13e94e8bb8",
"sha256": "85ca0fc7afb1d5d3dd2e5360a0a3625fa488a273617d315a1047758da20f72e8"
},
"downloads": -1,
"filename": "adafruit-circuitpython-vs1053-1.2.18.tar.gz",
"has_sig": false,
"md5_digest": "db549a5dec4319f17f498b13e94e8bb8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 29441,
"upload_time": "2023-12-09T17:36:52",
"upload_time_iso_8601": "2023-12-09T17:36:52.867605Z",
"url": "https://files.pythonhosted.org/packages/90/ea/8350e005d8569581a7aef5bbc6ad737afcb5d144efe89483ed0d98169f4e/adafruit-circuitpython-vs1053-1.2.18.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-09 17:36:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_VS1053",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-vs1053"
}
JSON
