Upgraded library to support most features of WM8960 I2C protocol

.pre-commit-config.yaml

@@ -2,6 +2,10 @@
 #
 # SPDX-License-Identifier: Unlicense
 
+default_language_version:
+    # force all unspecified python hooks to run python3.11
+    python: python3.11
+
 repos:
   - repo: https://github.com/python/black
     rev: 23.3.0

CODE_OF_CONDUCT.md

@@ -1,10 +1,10 @@
 <!--
 SPDX-FileCopyrightText: 2014 Coraline Ada Ehmke
-SPDX-FileCopyrightText: 2019-2021 Kattni Rembor for Adafruit Industries
+SPDX-FileCopyrightText: 2019-2021 Kattni Rembor
 
 SPDX-License-Identifier: CC-BY-4.0
 -->
-# Adafruit Community Code of Conduct
+# CircuitPython Community Code of Conduct
 
 ## Our Pledge
 
@@ -20,35 +20,52 @@ race, religion, or sexual identity and orientation.
 We are committed to providing a friendly, safe and welcoming environment for
 all.
 
-Examples of behavior that contributes to creating a positive environment
+Examples of behavior that contributes to creating and maintaining a positive environment
 include:
 
 * Be kind and courteous to others
 * Using welcoming and inclusive language
+* Respecting the identity of every community member, including asking for their
+  pronouns if uncertain
 * Being respectful of differing viewpoints and experiences
 * Collaborating with other community members
+* Providing desired assistance and knowledge to other community members
+* Being open to new information and ideas
 * Gracefully accepting constructive criticism
 * Focusing on what is best for the community
 * Showing empathy towards other community members
 
-Examples of unacceptable behavior by participants include:
+Examples of unacceptable behavior by community members include:
 
 * The use of sexualized language or imagery and sexual attention or advances
 * The use of inappropriate images, including in a community member's avatar
-* The use of inappropriate language, including in a community member's nickname
+* The use of inappropriate language or profanity, including in a community member's nickname
 * Any spamming, flaming, baiting or other attention-stealing behavior
 * Excessive or unwelcome helping; answering outside the scope of the question
   asked
 * Discussion or promotion of activities or projects that intend or pose a risk of
   significant harm
-* Trolling, insulting/derogatory comments, and personal or political attacks
+* Trolling, insulting/derogatory comments, and attacks of any nature (including,
+  but not limited to, personal or political attacks)
 * Promoting or spreading disinformation, lies, or conspiracy theories against
   a person, group, organisation, project, or community
 * Public or private harassment
 * Publishing others' private information, such as a physical or electronic
   address, without explicit permission
+* Engaging in behavior that creates an unwelcoming or uninclusive environment
 * Other conduct which could reasonably be considered inappropriate
 
+The CircuitPython Community welcomes everyone and strives to create a safe space for all. It is built
+around sharing and contributing to technology. We encourage discussing your thoughts, experiences,
+and feelings within the scope of the community. However, there are topics that can sometimes stray
+from that scope, and can lead to hurting others and create an unwelcoming, uninclusive environment.
+
+Examples of discussion topics that have been known to stray outside the scope of the CircuitPython
+Community include, but are not limited to:
+
+* Discussions regarding religion and related topics
+* Discussions regarding politics and related topics
+
 The goal of the standards and moderation guidelines outlined here is to build
 and maintain a respectful community. We ask that you don’t just aim to be
 "technically unimpeachable", but rather try to be your best self.
@@ -72,25 +89,21 @@ inappropriate, threatening, offensive, or harmful.
 
 ## Moderation
 
-Instances of behaviors that violate the Adafruit Community Code of Conduct
+Instances of behaviors that violate the CircuitPython Community Code of Conduct
 may be reported by any member of the community. Community members are
 encouraged to report these situations, including situations they witness
 involving other community members.
 
 You may report in the following ways:
 
-In any situation, you may email <support@adafruit.com>.
-
-On the Adafruit Discord, you may send an open message from any channel
-to all Community Moderators by tagging @community moderators. You may
-also send an open message from any channel, or a direct message to
-any Community Moderator.
+In any situation, you may email the project maintainer.
 
-Email and direct message reports will be kept confidential.
+The source of email and direct message reports will be kept confidential.
 
-In situations on Discord where the issue is particularly offensive, possibly
-illegal, requires immediate action, or violates the Discord terms of service,
-you should also report the message directly to [Discord](https://discord.com/safety).
+In situations on GitHub where the issue is particularly offensive, possibly
+illegal, requires immediate action, or violates the GitHub terms of service,
+you should also report the message directly to GitHub via the comment, or via
+[GitHub Support](https://support.github.com/contact/report-abuse?category=report-abuse&report=other&report_type=unspecified).
 
 These are the steps for upholding our community’s standards of conduct.
 
@@ -109,19 +122,18 @@ These are the steps for upholding our community’s standards of conduct.
    banned.
 6. Disciplinary actions (warnings, bans, etc) for Code of Conduct violations apply
    to the platform where the violation occurred. However, depending on the severity
-   of the violation, the disciplinary action may be applied across Adafruit's other
-   community platforms. For example, a severe violation on the Adafruit Discord
-   server may result in a ban on not only the Adafruit Discord server, but also on
-   the Adafruit GitHub organisation, Adafruit Forums, Adafruit Twitter, etc.
+   of the violation, the disciplinary action may be applied across CircuitPython's
+   other community platforms. For example, a severe violation in one Community forum
+   may result in a ban on not only the CircuitPython GitHub organisation,
+   but also on the CircuitPython Twitter, live stream text chats, etc.
 
 ## Scope
 
 This Code of Conduct and the enforcement policies listed above apply to all
-Adafruit Community venues. This includes but is not limited to any community
-spaces (both public and private), the entire Adafruit Discord server, and
-Adafruit GitHub repositories. Examples of Adafruit Community spaces include
-but are not limited to meet-ups, audio chats on the Adafruit Discord, or
-interaction at a conference.
+CircuitPython Community venues. This includes but is not limited to any community
+spaces (both public and private), and CircuitPython GitHub repositories. Examples of
+CircuitPython Community spaces include but are not limited to meet-ups, issue
+threads on GitHub, text chats during a live stream, or interaction at a conference.
 
 This Code of Conduct applies both within project spaces and in public spaces
 when an individual is representing the project or its community. As a community
@@ -130,11 +142,13 @@ accordingly.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/),
+This Code of Conduct is adapted from the
+[Adafruit Community Code of Conduct](https://github.com/adafruit/Adafruit_Community_Code_of_Conduct),
+which is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/),
 version 1.4, available on [contributor-covenant.org](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html),
 and the [Rust Code of Conduct](https://www.rust-lang.org/en-US/conduct.html).
 
-For other projects adopting the Adafruit Community Code of
+For other projects adopting the CircuitPython Community Code of
 Conduct, please contact the maintainers of those projects for enforcement.
 If you wish to use this code of conduct for your own project, consider
 explicitly mentioning your moderation policy or making a copy with your

LICENSE

@@ -1,6 +1,7 @@
-The MIT License (MIT)
+MIT License
 
 Copyright (c) 2023 Scott Shawcroft for Adafruit Industries
+Copyright (c) 2024 Cooper Dalrymple
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.rst

@@ -1,28 +1,22 @@
 Introduction
 ============
-
-
 .. image:: https://readthedocs.org/projects/adafruit-circuitpython-wm8960/badge/?version=latest
     :target: https://docs.circuitpython.org/projects/wm8960/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_WM8960/workflows/Build%20CI/badge.svg
     :target: https://github.com/adafruit/Adafruit_CircuitPython_WM8960/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
 
-Barebones CircuitPython driver for WM8960 Stereo CODEC
-
+CircuitPython driver for WM8960 Stereo CODEC
 
 Dependencies
 =============
@@ -32,27 +26,18 @@ This driver depends on:
 * `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://circuitpython.org/libraries>`_
-or individual libraries can be installed using
-`circup <https://github.com/adafruit/circup>`_.
-
-
+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>`_.
 
-.. todo:: Describe the Adafruit product this library works with. For PCBs, you can also add the
-image from the assets folder in the PCB's GitHub repo.
+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.
 
-`Purchase one from the Adafruit shop <http://www.adafruit.com/products/>`_
+This library has been tested using an RP2040 on CircuitPython 9.1.1 and the `SparkFun Audio Codec PBreakout - WM8960 <https://www.sparkfun.com/products/21250>`_.
 
 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!
+.. note:: This library is not available on PyPI yet. Install documentation is included as a standard element. Stay tuned for PyPI availability!
 
-.. todo:: Remove the above note if PyPI version is/will be available at time of release.
+On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from PyPI <https://pypi.org/project/adafruit-circuitpython-wm8960/>`_.
 
-On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
-PyPI <https://pypi.org/project/adafruit-circuitpython-wm8960/>`_.
 To install for current user:
 
 .. code-block:: shell
@@ -100,19 +85,27 @@ Or the following command to update an existing version:
 Usage Example
 =============
 
-.. todo:: Add a quick, simple example. It and other examples should live in the
-examples folder and be included in docs/examples.rst.
+.. code-block:: python
+
+    # Monitor Stereo MIC Input:
+    # MIC (INPUT1) => PGA => Boost Mixer => Output Mixer => Headphones
+    import board, adafruit_wm8960
+    codec = adafruit_wm8960.WM8960(board.I2C())
+    codec.enableMIC()
+    codec.enableMN1()
+    codec.enableINMUTE()
+    codec.setMICBOOST(adafruit_wm8960.WM8960_MIC_BOOST_GAIN_0DB)
+    codec.connectMIC2B()
+    codec.enableAIN()
+    codec.enableB2O()
+    codec.setB2OVOL(adafruit_wm8960.WM8960_OUTPUT_MIXER_GAIN_0DB)
+    codec.enableOMIX()
+    codec.configureHeadphones()
 
 Documentation
 =============
-API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/wm8960/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>`_.
+API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/adafruit_wm8960/en/latest/>`_.
 
 Contributing
 ============
-
-Contributions are welcome! Please read our `Code of Conduct
-<https://github.com/adafruit/Adafruit_CircuitPython_WM8960/blob/HEAD/CODE_OF_CONDUCT.md>`_
-before contributing to help this project stay welcoming.
+Contributions are welcome! Please read our `Code of Conduct <https://github.com/adafruit/Adafruit_CircuitPython_WM8960/blob/HEAD/CODE_OF_CONDUCT.md>`_ before contributing to help this project stay welcoming.

README.rst.license

@@ -1,3 +1,4 @@
 SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
 SPDX-FileCopyrightText: Copyright (c) 2023 Scott Shawcroft for Adafruit Industries
+SPDX-FileCopyrightText: Copyright (c) 2024 Cooper Dalrymple
 SPDX-License-Identifier: MIT