Add files via upload

Author: redoxcode

LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2022 redoxcode
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

README.md

@@ -0,0 +1,101 @@
+## Description
+A micropython library to control the DFPlayer mini mp3 player module.
+
+This library focuses on the most essential functions. Some advanced functions of the dfmini, like the equalizer modes are not implemented yet.
+
+Further this library is made to use the folders function of the dfmini. You can use up to 99 folders and 255 files per folder.
+The files on your micro sd card need to be structured like this:
+
+	.
+	├── 01
+	│   ├── 001.mp3
+	│   ├── 002.mp3
+	│   └── ...
+	├── 02
+	│   ├── 001.mp3
+	│   ├── 002.mp3
+	│   └── ...
+	├── 03
+	│   ├── 001.mp3
+	│   ├── 002.mp3
+	│   └── ...
+	└── ...
+
+There should be no gaps in the numbering scheme.
+It might be best to prepare the whole file structure on your harddrive first and then copy them in one go on a freshly formated micro sd card, as the dfmini might get confused from artifacts left on the sd cards filesystem.
+You can use the files in /sample_files to test your module.
+
+Sometimes the module isn't able to keep up if you try to send commands to fast, so some delay between the commands is needed.
+
+## Examples
+
+### Play a file from a folder
+```Python
+import time
+from dfplayer import DFPlayer
+df=DFPlayer(uart_id=1,tx_pin_id=4,rx_pin_id=5)
+#wait some time till the DFPlayer is ready
+time.sleep(0.2)
+#change the volume (0-30). The DFPlayer doesn't remember these settings
+df.volume(25)
+time.sleep(0.2)
+#play file ./01/001.mp3
+df.play(1,1)
+```
+### Find the number of files in a folder
+If a folder doesn't exist, get_files_in_folder will return -1
+```Python
+import time
+from dfplayer import DFPlayer
+df=DFPlayer(uart_id=1,tx_pin_id=4,rx_pin_id=5)
+#wait some time till the DFPlayer is ready
+time.sleep(0.2)
+print(df.get_files_in_folder(1))
+time.sleep(0.2)
+print(df.get_files_in_folder(4))
+```
+
+## API
+### class DFPlayer(uart_id,tx_pin_id=None,rx_pin_id=None)
+- uart_id: Uart channel you want to use (0 or 1 for pi pico)
+- tx_pin_id: Pin id for uart tx if your board supports changing the pins of the uart channel.  
+- tx_pin_id: Pin id for uart rx if your board supports changing the pins of the uart channel.  
+
+```play(folder,file)```
+Play a file from a folder (stops all previous playback)
+- folder: Folder number of the file you want to play
+- file: File number of the file you want to play
+
+```stop()```
+Stop all playback
+
+```volume(vol)```
+Set the volume of the module
+- vol: Volume of the module. The range is 0 to 30. The DFPlayer doesn't remember these settings
+
+```get_volume()```
+Returns the current volume setting of the module
+
+```ìs_playing()```
+Returns if currently some playback is running
+
+```get_files_in_folder(folder)```
+Returns the number of files in a folder or -1 if the folder doesn't exist
+- folder: folder to get the number of files in
+
+```reset()```
+Reset the module
+
+```send_cmd(cmd,param1=0,param2=0)```
+Sends a command byte with 2 bytes for parameters to the module.
+This can be used to send commands not yet implemented in this library
+- cmd: cammand byte (0-255)
+- param1: parameter 1 or MSB of a 2 byte parameter
+- param2: parameter 2 or LSB of a 2 byte parameter
+
+```send_query(cmd,param1=0,param2=0)```
+Like send_cmd, but returns the bytes the module sends as answer to the query
+- cmd: cammand byte (0-255)
+- param1: parameter 1 or MSB of a 2 byte parameter
+- param2: parameter 2 or LSB of a 2 byte parameter
+

pyproject.toml

@@ -0,0 +1,27 @@
+# pyproject.toml
+
+[build-system]
+requires      = ["setuptools>=61.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "micropython-dfmini"
+version = "1.0.0"
+description = "Library to use the DFPlayer mini mp3 player module with micropython"
+readme = "README.md"
+authors = [{ name = "redoxcode", email = "[email protected]" }]
+license = { file = "LICENSE" }
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: Implementation :: MicroPython"
+]
+keywords = ["dfmini","dfplayer", "mp3"]
+dependencies = []
+
+[project.optional-dependencies]
+dev = []
+
+[project.urls]
+Homepage = "https://github.com/redoxcode/micropython-dfplayer"
+
+

sample_files/01/001.mp3

@@ -0,0 +1,91 @@
+import machine
+import time
+
+class DFPlayer:
+    def __init__(self,uart_id,tx_pin_id=None,rx_pin_id=None):
+        self.uart_id=uart_id
+        #init with given baudrate
+        self.uart = machine.UART(uart_id, 9600)  
+                
+        #not all boards can set the pins for the uart channel
+        if tx_pin_id or rx_pin_id:
+		    self.tx_pin=machine.Pin(tx_pin_id,machine.Pin.OUT)
+		    self.rx_pin=machine.Pin(rx_pin_id,machine.Pin.IN)     
+        	self.uart.init(9600, bits=8, parity=None, stop=1, tx=self.tx_pin, rx=self.rx_pin)
+        else:
+        	self.uart.init(9600, bits=8, parity=None, stop=1)
+        
+    def flush(self):
+        while self.uart.any():
+            self.uart.read()
+        
+    def send_query(self,cmd,param1=0,param2=0):  
+        self.flush()
+        self.send_cmd(cmd,param1,param2)
+        time.sleep(0.05)
+        return self.uart.read()
+    
+    def send_cmd(self,cmd,param1=0,param2=0):
+        out_bytes = bytearray(10)
+        out_bytes[0]=126
+        out_bytes[1]=255
+        out_bytes[2]=6
+        out_bytes[3]=cmd
+        out_bytes[4]=0
+        out_bytes[5]=param1
+        out_bytes[6]=param2
+        out_bytes[9]=239
+        checksum = 0
+        for i in range(1,7):
+            checksum=checksum+out_bytes[i]
+        out_bytes[7]=(checksum>>7)-1
+        out_bytes[7]=~out_bytes[7]
+        out_bytes[8]=checksum-1
+        out_bytes[8]=~out_bytes[8]
+        self.uart.write(out_bytes)
+
+    def stop(self):
+        self.send_cmd(22,0,0)
+        
+    def play(self,folder,file):
+        self.stop()
+        time.sleep(0.05)
+        self.send_cmd(15,folder,file)
+        
+    def volume(self,vol):
+        df.send_cmd(6,0,vol)
+    
+    def reset(self):
+        df.send_cmd(12,0,1)
+        
+    def is_playing(self):
+        return df.send_query(66)[6]
+    
+    def get_volume(self):
+        return df.send_query(67)[6]
+
+    def get_files_in_folder(self,folder):
+        in_bytes = df.send_query(78,0,folder)
+        if in_bytes[3]!=78:
+            return -1
+        return in_bytes[6]
+
+
+df = DFPlayer(1,4,5)
+time.sleep(0.2)
+df.volume(30)
+#df.reset()
+time.sleep(1.0)
+print(df.get_files_in_folder(0))
+time.sleep(0.2)
+print(df.get_files_in_folder(1))
+time.sleep(0.2)
+print(df.get_files_in_folder(2))
+time.sleep(0.5)
+print(df.get_files_in_folder(3))
+time.sleep(0.5)
+print(df.get_files_in_folder(4))
+
+#df.play(1,1)
+#time.sleep(0.5)
+#df.stop()