Introduction
============
.. image:: https://readthedocs.org/projects/mindwidgets-circuitpython-df1201s-library/badge/?version=latest
:target: https://mindwidgets-circuitpython-df1201s-library.readthedocs.io/
:alt: Documentation Status
.. image:: https://img.shields.io/discord/327254708534116352.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/mindwidgets/Mindwidgets_CircuitPython_DF1201S/workflows/Build%20CI/badge.svg
:target: https://github.com/mindwidgets/Mindwidgets_CircuitPython_DF1201S/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
CircuitPython driver for DFRobot DFPlayer Pro MP3 player with onboard storage
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
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/mindwidgets-circuitpython-df1201s/>`_.
To install for current user:
.. code-block:: shell
pip3 install mindwidgets-circuitpython-df1201s
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install mindwidgets-circuitpython-df1201s
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 mindwidgets-circuitpython-df1201s
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 df1201s
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python
import board
import busio
from mindwidgets_df1201s import DF1201S
uart = busio.UART(tx=board.GP16, rx=board.GP17, baudrate=115200)
df_player = DF1201S(uart)
df_player.volume = 0.2
df_player.play_mode = DF1201S.PLAYMODE_PLAY_ONCE
if not df_player.play_next():
print("No sound files to play!")
while True:
pass
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://mindwidgets-circuitpython-df1201s-library.readthedocs.io/>`_.
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/mindwidgets/Mindwidgets_CircuitPython_DF1201S/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "mindwidgets-circuitpython-df1201s",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, df1201s, dfplayer, mp3, wav, wma, flac, aac, ape, dfrobot",
"author": null,
"author_email": "Mindwidgets <aaron@mindwidgets.com>",
"download_url": "https://files.pythonhosted.org/packages/24/94/bdba178b5e8860601296601102795694bd36ce505944b566812ff2af3aeb/mindwidgets_circuitpython_df1201s-0.1.2.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/mindwidgets-circuitpython-df1201s-library/badge/?version=latest\n :target: https://mindwidgets-circuitpython-df1201s-library.readthedocs.io/\n :alt: Documentation Status\n\n\n\n.. image:: https://img.shields.io/discord/327254708534116352.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n\n.. image:: https://github.com/mindwidgets/Mindwidgets_CircuitPython_DF1201S/workflows/Build%20CI/badge.svg\n :target: https://github.com/mindwidgets/Mindwidgets_CircuitPython_DF1201S/actions\n :alt: Build Status\n\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\nCircuitPython driver for DFRobot DFPlayer Pro MP3 player with onboard storage\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\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://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\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/mindwidgets-circuitpython-df1201s/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install mindwidgets-circuitpython-df1201s\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install mindwidgets-circuitpython-df1201s\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 .env/bin/activate\n pip3 install mindwidgets-circuitpython-df1201s\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install df1201s\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import board\n import busio\n from mindwidgets_df1201s import DF1201S\n\n uart = busio.UART(tx=board.GP16, rx=board.GP17, baudrate=115200)\n\n df_player = DF1201S(uart)\n df_player.volume = 0.2\n df_player.play_mode = DF1201S.PLAYMODE_PLAY_ONCE\n\n if not df_player.play_next():\n print(\"No sound files to play!\")\n\n while True:\n pass\n\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://mindwidgets-circuitpython-df1201s-library.readthedocs.io/>`_.\n\nFor information on building library documentation, please check out\n`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/mindwidgets/Mindwidgets_CircuitPython_DF1201S/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython driver for DFRobot DFPlayer Pro MP3 player with onboard storage",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://github.com/mindwidgets/Mindwidgets_CircuitPython_DF1201S"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" df1201s",
" dfplayer",
" mp3",
" wav",
" wma",
" flac",
" aac",
" ape",
" dfrobot"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b3b24f6ef38cee2ea5db659bfb44da1a8cb8f78cc0e6e610cceef424d3948c39",
"md5": "1d46bb1e839afece1a2a2e233becd8a6",
"sha256": "1678fcdf07d13f12e8d2eb571d2bdc06ca291191f08706e2bd2937a6a814458b"
},
"downloads": -1,
"filename": "mindwidgets_circuitpython_df1201s-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1d46bb1e839afece1a2a2e233becd8a6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6680,
"upload_time": "2024-07-28T17:04:55",
"upload_time_iso_8601": "2024-07-28T17:04:55.396363Z",
"url": "https://files.pythonhosted.org/packages/b3/b2/4f6ef38cee2ea5db659bfb44da1a8cb8f78cc0e6e610cceef424d3948c39/mindwidgets_circuitpython_df1201s-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2494bdba178b5e8860601296601102795694bd36ce505944b566812ff2af3aeb",
"md5": "a3b90693f157399c5f1f15439c922e93",
"sha256": "056cecf826bb519c45d74fd287944e04884dd24c0cae1ab5f65a71e1b7c91e28"
},
"downloads": -1,
"filename": "mindwidgets_circuitpython_df1201s-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "a3b90693f157399c5f1f15439c922e93",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 31090,
"upload_time": "2024-07-28T17:04:56",
"upload_time_iso_8601": "2024-07-28T17:04:56.647296Z",
"url": "https://files.pythonhosted.org/packages/24/94/bdba178b5e8860601296601102795694bd36ce505944b566812ff2af3aeb/mindwidgets_circuitpython_df1201s-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-28 17:04:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mindwidgets",
"github_project": "Mindwidgets_CircuitPython_DF1201S",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
}
],
"lcname": "mindwidgets-circuitpython-df1201s"
}
JSON
