1.0.1

Introduction
============


.. image:: https://readthedocs.org/projects/adafruit-circuitpython-nau88l21/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/nau88l21/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_NAU88L21/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_NAU88L21/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

Driver library for the nuvoton NAU88L21 audio CODEC


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

.. code-block:: shell

    pip3 install adafruit-circuitpython-nau88l21

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-nau88l21

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

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_nau88l21

Or the following command to update an existing version:

.. code-block:: shell

    circup update

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

.. code-block:: python

    import time

    import audiobusio
    import board
    import synthio

    import adafruit_nau88l21

    RATE = 48000  # frame rate on the wire; also what the codec's FLL locks to

    DAC_VOLUME = 0
    HEADPHONE_VOLUME = 0

    # MIDI note numbers for a C-major scale, C4 up to C5.
    SCALE = (60, 62, 64, 65, 67, 69, 71, 72)
    NOTE_SECONDS = 0.4

    # CAUTION: this drives the headphone amplifier. Take the headphones off before
    # the first run and confirm the level is comfortable before wearing them.

    i2s = audiobusio.I2SOut(board.I2S_BIT_CLOCK, board.I2S_WORD_SELECT, board.I2S_DOUT)

    synth = synthio.Synthesizer(sample_rate=RATE)

    i2s.play(synth)

    codec = adafruit_nau88l21.NAU88L21(board.I2C())
    codec.configure_clocks()

    codec.headphone_output = True
    codec.dac_volume = DAC_VOLUME
    codec.headphone_volume = HEADPHONE_VOLUME

    print("playing scale")
    try:
        while True:
            for note in SCALE:
                synth.press(note)
                time.sleep(0.25)
                synth.release(note)
                time.sleep(0.125)
    finally:
        i2s.stop()
        i2s.deinit()

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