First push of code and docs

Author: aaronsilinskas

README.rst

@@ -89,8 +89,24 @@ 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
+
+    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
 =============

docs/examples.rst

@@ -1,8 +1,19 @@
 Simple test
 ------------
 
-Ensure your device works with this simple test.
+Ensure your device works with this simple test. When working, will play the first
+sound stored on the DFPlayer Pro.
 
 .. literalinclude:: ../examples/df1201s_simpletest.py
     :caption: examples/df1201s_simpletest.py
     :linenos:
+
+More Features
+--------------
+
+Explore more features of the DFPlayer Pro, including volume adjustment, play modes, 
+and play status.
+
+.. literalInclude:: ../examples/df1201s_morefeatures.py
+    :caption: examples/df1201s_morefeatures.py
+    :linenos:

examples/df1201s_morefeatures.py

@@ -0,0 +1,47 @@
+# SPDX-FileCopyrightText: Copyright (c) 2022 Aaron Silinskas for Mindwidgets
+#
+# SPDX-License-Identifier: MIT
+
+import board
+import time
+import busio
+from mindwidgets_df1201s import DF1201S
+
+uart = busio.UART(tx=board.GP16, rx=board.GP17, baudrate=115200)
+
+df_player = DF1201S(uart)
+
+print("Disabling start-up prompt (persists after power off)")
+df_player.disable_prompt()
+
+print("Volume:", df_player.volume)
+df_player.volume = 0.2
+print("New Volume:", df_player.volume)
+df_player.increase_volume(0.05)
+print("Increased Volume:", df_player.volume)
+df_player.decrease_volume(0.1)
+print("Decreased Volume:", df_player.volume)
+df_player.play_mode = DF1201S.PLAYMODE_REPEAT_ONE_SONG
+print("Mode:", df_player.play_mode)
+
+print("File Count:", df_player.total_files)
+
+df_player.enable_led()
+print("Play song")
+
+if not df_player.play_next():
+    print("No sound files to play!")
+
+print("Current file number:", df_player.file_number)
+print("Current file name: ", df_player.file_name)
+print("Length of the current file in seconds:", df_player.total_time)
+
+while df_player.playing:
+    time.sleep(0.5)
+
+print("Done playing")
+
+df_player.disable_led()
+
+while True:
+    pass

examples/df1201s_simpletest.py

@@ -1,4 +1,19 @@
-# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
 # SPDX-FileCopyrightText: Copyright (c) 2022 Aaron Silinskas for Mindwidgets
 #
-# SPDX-License-Identifier: Unlicense
+# SPDX-License-Identifier: MIT
+
+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