Init

Author: codingABI

LICENSE.txt

@@ -0,0 +1,11 @@
+BSD 2-Clause License
+
+Copyright (c) 2024, codingABI All rights reserved.
+  
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -0,0 +1,90 @@
+# DFR0534
+Arduino Uno/Nano library for a [DFR0534](https://wiki.dfrobot.com/Voice_Module_SKU__DFR0534) audio module. The library works with SoftwareSerial and is very similar to https://github.com/sleemanj/JQ8400_Serial, but is no fork.
+
+To create a DFR0534 object pass the existing SoftwareSerial object as parameter to the DFR0534 constructor, for example
+
+```
+#include <SoftwareSerial.h>
+#include <DFR0534.h>
+
+#define TX_PIN A0
+#define RX_PIN A1
+SoftwareSerial g_serial(RX_PIN, TX_PIN);
+DFR0534 g_audio(g_serial);
+...
+```
+
+Examples how to use the library
+- [playFileByName](/examples/playFileByName/playFileByName.ino)
+- [playFileByNumber](/examples/playFileByNumber/playFileByNumber.ino)
+- [playCombined](/examples/playCombined/playCombined.ino)
+
+## License and copyright
+This library is licensed under the terms of the 2-Clause BSD License [Copyright (c) 2024 codingABI](LICENSE.txt). 
+
+## Appendix
+
+### Supported functions
+
+
+| Function  | Notes |
+| ------------- | ------------- |
+| decreaseVolume |   |
+| fastBackwardDuration |   |
+| fastForwardDuration |   |
+| getDrive | Returns DFR0534::DRIVEUSB, DFR0534::DRIVESD, DFR0534::DRIVEFLASH or DFR0534::DRIVEUNKNOWN, Example [playFileByNumber](/examples/playFileByNumber/playFileByNumber.ino) |
+| getDrivesStates | Returns bitmask for DFR0534::DRIVEUSB, DFR0534::DRIVESD, DFR0534::DRIVEFLASH, Example [playFileByNumber](/examples/playFileByNumber/playFileByNumber.ino) |
+| getDuration |   |
+| getFileName | Example [playFileByNumber](/examples/playFileByNumber/playFileByNumber.ino)  |
+| getFileNumber | Example [playFileByNumber](/examples/playFileByNumber/playFileByNumber.ino)  |
+| getFirstFileNumberInCurrentDirectory | Example [playFileByNumber](/examples/playFileByNumber/playFileByNumber.ino)  |
+| getRuntime |   |
+| getStatus | Returns DFR0534::STOPPED, DFR0534::PLAYING, DFR0534::PAUSED or DFR0534::STATUSUNKNOWN, Example [playFileByNumber](/examples/playFileByNumber/playFileByNumber.ino)|
+| getTotalFiles | Example [playFileByNumber](/examples/playFileByNumber/playFileByNumber.ino)  |
+| getTotalFilesInCurrentDirectory | Example [playFileByNumber](/examples/playFileByNumber/playFileByNumber.ino)  |
+| increaseVolume |   |
+| insertFileByNumber |   |
+| pause |   |
+| play |   |
+| playCombined | The DFR0534 uses a special two char file name format and fixed folder /ZH for this function. Look a the a the example [playCombined](/examples/playCombined/playCombined.ino) or  comments to this function in [DFR0534.cpp](src/DFR0534.cpp) for details |
+| playFileByName | The DFR0534 uses a special 8+3 file name format. Before using this function take a look a the example [playFileByName](/examples/playFileByName/playFileByName.ino) or the comments to this function in [DFR0534.cpp](src/DFR0534.cpp) for details |
+| playFileByNumber | Example [playFileByNumber](/examples/playFileByNumber/playFileByNumber.ino)  |
+| playLastInDirectory |   |
+| playNext |   |
+| playNextDirectory |   |
+| playPrevious |   |
+| prepareFileByNumber |   |
+| repeatPart |   |
+| setChannel | Supports DFR0534::CHANNELMP3, DFR0534::CHANNELDAC and DFR0534::CHANNELMP3AUX |
+| setDrive | Supports DFR0534::DRIVEUSB, DFR0534::DRIVESD and DFR0534::DRIVEFLASH |
+| setDirectory | Seems not to work |
+| setEqualizer | Supports DFR0534::NORMAL, DFR0534::POP, DFR0534::ROCK, DFR0534::JAZZ and DFR0534::CLASSIC  |
+| setLoopMode | Supports DFR0534::LOOPBACKALL, DFR0534::SINGLEAUDIOLOOP, DFR0534::SINGLEAUDIOSTOP, DFR0534::PLAYRANDOM, DFR0534::DIRECTORYLOOP, DFR0534::RANDOMINDIRECTORY, DFR0534::SEQUENTIALINDIRECTORY and DFR0534::SEQUENTIAL |
+| setRepeatLoops |   |
+| setVolume | Volume level (0 = mute, 30 = max), Example [playFileByNumber](/examples/playFileByNumber/playFileByNumber.ino)  |
+| startSendingRuntime |   |
+| stop |   |
+| stopCombined |   |
+| stopInsertedFile |   |
+| stopRepeatPart |   |
+| stopSendingRuntime |   |
+
+For function details see comments in [DFR0534.cpp](src/DFR0534.cpp)
+
+
+### DF0534 pinout
+![DFR0534](assets/images/DFR0534.jpg)
+
+Minimal schematic to use this library
+| Pin  | Connteced to |
+| ------------- | ------------- |
+| TX | Used SoftwareSerial RX  |
+| RX | Used SoftwareSerial TX* |
+| GND | Ground  |
+| VCC | 3.3-5V  |
+| SP+ | Speaker + connector |
+| SP- | Speaker - connector |
+
+*If your microcontroller runs at 5V use a 1k resistor between RX and SoftwareSerial TX.
+
+