Skip to main content

Introduction

Documentation Status Discord Build Status Code Style: Ruff

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:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-vs1053

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

sudo pip3 install adafruit-circuitpython-vs1053

To install in a virtual environment in your current project:

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.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Metadata

Release files for adafruit-circuitpython-vs1053 1.2.26

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for adafruit-circuitpython-vs1053 1.2.26
File Size Uploaded
adafruit_circuitpython_vs1053-1.2.26.tar.gz 26.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for adafruit-circuitpython-vs1053 1.2.26
File Interpreter ABI Platform
adafruit_circuitpython_vs1053-1.2.26-py3-none-any.whl Python 3 none any Details

Total release size: 33.1 kB

Release files / adafruit_circuitpython_vs1053-1.2.26.tar.gz

Download URL adafruit_circuitpython_vs1053-1.2.26.tar.gz
Size 26.2 kB
Tags Source
SHA-256 checksum
How to use checksums
f063aef710da5a90581853a605b8d8b1bbe76af857f4a5ccd54dbbe5da25ff2d
BLAKE2b-256 checksum
How to use checksums
7e4bfb694fcb0822df10806d7ed93aac543df32302f3c54071ade0f426d520e2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.15

Release files / adafruit_circuitpython_vs1053-1.2.26-py3-none-any.whl

Download URL adafruit_circuitpython_vs1053-1.2.26-py3-none-any.whl
Size 6.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
cc61e94f9348dc33a92697429dae662ea1bdbb65aaaba4c968149779f978d6d3
BLAKE2b-256 checksum
How to use checksums
d9b1d8a57eb9768910f92776580a3215ef58f33d6e83435ba196aacb1285c8df
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.15

Release history Release notifications | RSS feed

This release

1.2.26 This release

2 release files

1.2.25

2 release files

1.2.24

2 release files

1.2.23

2 release files

1.2.22

2 release files

1.2.21

2 release files

1.2.17

2 release files

1.2.16

2 release files

1.2.15

2 release files

1.2.14

2 release files

1.2.13

2 release files

1.2.12

2 release files

1.2.10

1 release file

1.2.9

1 release file

1.2.8

1 release file

1.2.7

1 release file

1.2.6

1 release file

1.2.5

1 release file

1.2.4

1 release file

1.2.3

1 release file

1.2.2

1 release file

1.2.1

1 release file

1.2.0

1 release file

1.1.2

1 release file

1.1.1

1 release file

1.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page