Introduction

CircuitPython driver for WM8960 Stereo CODEC

Dependencies

This driver depends on:

• Adafruit CircuitPython
• Bus Device

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.

This library is designed to help facilite the I2C connection with a WM8960 audio codec to configure it to be used for DAC, ADC, headphone and speaker functionality.

This library has been tested using an RP2040 on CircuitPython 9.1.1 and the SparkFun Audio Codec PBreakout - WM8960.

Installing from PyPI

Note

This library is not available on PyPI yet. Install documentation is included as a standard element. Stay tuned for PyPI availability!

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

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

sudo pip3 install adafruit-circuitpython-wm8960

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install adafruit-circuitpython-wm8960

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:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install adafruit_wm8960

Or the following command to update an existing version:

circup update

Usage Example

# Monitor Stereo Input: INPUT3 => Output Mixer => Headphones
import board
from adafruit_wm8960 import Input, WM8960
codec = WM8960(board.I2C())
codec.input = Input.LINE3
codec.gain = 0.5
codec.monitor = 1.0
codec.headphone = 0.5

Documentation

API documentation for this library can be found on Read the Docs.

Contributing

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