Update for 1.0.1

codingABI · codingABI · commit 1dce9fd22a5e · 2024-01-12T17:50:45.000+01:00
PDF documentation, Fix channel names and add DRIVENO
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+internal
diff --git a/DFR0534.pdf b/DFR0534.pdf
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 # 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.
+An 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
 
@@ -14,6 +14,8 @@ DFR0534 g_audio(g_serial);
 ...
 ```
 
+[PDF-Documentation](DFR0534.pdf)
+
 Examples how to use the library
 - [playFileByName](/examples/playFileByName/playFileByName.ino)
 - [playFileByNumber](/examples/playFileByNumber/playFileByNumber.ino)
@@ -55,7 +57,7 @@ This library is licensed under the terms of the 2-Clause BSD License [Copyright
 | playPrevious |   |
 | prepareFileByNumber |   |
 | repeatPart |   |
-| setChannel | Supports DFR0534::CHANNELMP3, DFR0534::CHANNELDAC and DFR0534::CHANNELMP3AUX |
+| setChannel | Seems make no sense on a DFR0534 audio module |
 | 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  |
@@ -76,7 +78,7 @@ For function details see comments in [DFR0534.cpp](src/DFR0534.cpp)
 ![DFR0534](assets/images/DFR0534.jpg)
 
 Minimal schematic to use this library
-| Pin  | Connteced to |
+| Pin  | Connected to |
 | ------------- | ------------- |
 | TX | Used SoftwareSerial RX  |
 | RX | Used SoftwareSerial TX* |
diff --git a/examples/playCombined/playCombined.ino b/examples/playCombined/playCombined.ino
@@ -1,6 +1,6 @@
-/* 
+/*
  * Example for using the DFR0534 for playing combined audio files like a playlist
- */ 
+ */
 
 #include <SoftwareSerial.h>
 #include <DFR0534.h>
@@ -17,25 +17,25 @@ void setup() {
   g_serial.begin(9600);
 
   // Set volume
-  g_audio.setVolume(20);
-  
-  /* The parameter string for the playCombined function is just 
-   * a concatenation of all files in the desired order without 
+  g_audio.setVolume(18);
+
+  /* The parameter string for the playCombined function is just
+   * a concatenation of all files in the desired order without
    * path and without extension.
    * All files have to be in the folder /ZH and the each
-   * file has to have a length (without extension) of two chars. 
+   * file has to have a length (without extension) of two chars.
    *
    * You can get example files from https://github.com/codingABI/DFR0534/tree/main/assets/exampleContent
    */
 
-  /* Plays files the custom order, like a playlist and stops after the last file: 
+  /* Plays files the custom order, like a playlist and stops after the last file:
    * /ZH/05.wav
    * /ZH/04.wav
    * /ZH/03.wav
    * /ZH/02.wav
    * /ZH/01.wav
    * /ZH/0A.wav
-   */   
+   */
   g_audio.playCombined("05040302010A");
 }
 
@@ -48,10 +48,10 @@ void loop() {
     Serial.print("number: ");
     word fileNumber = g_audio.getFileNumber();
     if (fileNumber > 0) Serial.print(fileNumber); else Serial.print("--");
-    
+
     Serial.print(" name: ");
     if (g_audio.getFileName(name)) Serial.print(name);
-    
+
     Serial.print(" status: ");
     switch (g_audio.getStatus()) {
       case DFR0534::STOPPED:
diff --git a/examples/playFileByName/playFileByName.ino b/examples/playFileByName/playFileByName.ino
@@ -1,6 +1,6 @@
-/* 
+/*
  * Example for using the DFR0534 for playing audio files by file name
- */ 
+ */
 
 #include <SoftwareSerial.h>
 #include <DFR0534.h>
@@ -17,17 +17,22 @@ void setup() {
   g_serial.begin(9600);
 
   // Set volume
-  g_audio.setVolume(20);
-  
-  /* The parameter string for the function playFileByName is the full path 
-   * of the audio file to be played in special format which looks like 
-   * a 8+3 format: 
-   * - without the dot for the file extension
-   * - every file and folder which length is shorter then 
-   *   8 chars must be filled up to the 8 chars length by spaces.
+  g_audio.setVolume(18);
+
+  /* The file name/path for the function playFileByName() is the full path of the audio file to be played
+   * in format which looks like a special unix 8+3 format:
+   * - Without the dot for the file extension
+   * - All characters in upper case
+   * - Every file and folder whose length is shorter then 8 chars must be filled up to the 8 chars length by spaces.
    * - Only WAV and MP3 files are supported
-   * Wildcards * and ? are allowed and can be used to reduce 
-   * filling spaces.
+   * Wildcards * (=multiple arbitrary characters) and ? (=one single arbitrary character) are allowed and can be used to reduce filling spaces.
+   *
+   * Valid examples:
+   * - "/01      WAV" for file 01.wav
+   * - "/99-AFR~1MP3" for a file /99-Africa.mp3
+   * - "/99-AFR*MP3" for first file matching /99-Afr*.mp3
+   * - "/10*" for first audio file matching /10*.*
+   * - "/10      /20      WAV" for the file /10/20.wav
    *
    * You can get example files from https://github.com/codingABI/DFR0534/tree/main/assets/exampleContent
    *
@@ -52,10 +57,10 @@ void loop() {
     Serial.print("number: ");
     word fileNumber = g_audio.getFileNumber();
     if (fileNumber > 0) Serial.print(fileNumber); else Serial.print("--");
-    
+
     Serial.print(" name: ");
     if (g_audio.getFileName(name)) Serial.print(name);
-    
+
     Serial.print(" status: ");
     switch (g_audio.getStatus()) {
       case DFR0534::STOPPED:
diff --git a/examples/playFileByNumber/playFileByNumber.ino b/examples/playFileByNumber/playFileByNumber.ino
@@ -1,6 +1,6 @@
-/* 
+/*
  * Example for using the DFR0534 for playing audio files by file number
- */ 
+ */
 
 #include <SoftwareSerial.h>
 #include <DFR0534.h>
@@ -17,16 +17,16 @@ void setup() {
   g_serial.begin(9600);
 
   // Set volume
-  g_audio.setVolume(20);
-  
+  g_audio.setVolume(18);
+
   // Show some device infos
   Serial.print("Ready drives: ");
   byte drive = g_audio.getDrivesStates();
   if (((drive >> DFR0534::DRIVEUSB) & 1) == 1) Serial.print("USB ");
   if (((drive >> DFR0534::DRIVESD) & 1) == 1) Serial.print("SD ");
-  if (((drive >> DFR0534::DRIVEFLASH) & 1) == 1) Serial.print("FLASH ");  
+  if (((drive >> DFR0534::DRIVEFLASH) & 1) == 1) Serial.print("FLASH ");
   Serial.println();
-  
+
   Serial.print("Current playing drive: ");
   switch(g_audio.getDrive()) {
     case DFR0534::DRIVEUSB:
@@ -38,6 +38,9 @@ void setup() {
     case DFR0534::DRIVEFLASH:
       Serial.println("FLASH");
       break;
+    case DFR0534::DRIVENO:
+      Serial.println("No drive");
+      break;
     default:
       Serial.println("Unknown");
       break;
@@ -65,10 +68,10 @@ void loop() {
     Serial.print("number: ");
     word fileNumber = g_audio.getFileNumber();
     if (fileNumber > 0) Serial.print(fileNumber); else Serial.print("--");
-    
+
     Serial.print(" name: ");
     if (g_audio.getFileName(name)) Serial.print(name);
-    
+
     Serial.print(" status: ");
     switch (g_audio.getStatus()) {
       case DFR0534::STOPPED:
diff --git a/keywords.txt b/keywords.txt
@@ -12,58 +12,58 @@ DFR0534	KEYWORD1
 # Methods and Functions (KEYWORD2)
 #######################################
 
-getStatus	KEYWORD2
-setEqualizer	KEYWORD2
-playFileByNumber	KEYWORD2
-setVolume	KEYWORD2
-play	KEYWORD2
-pause	KEYWORD2
-stop	KEYWORD2
-playPrevious	KEYWORD2
-playNext	KEYWORD2
-playFileByName	KEYWORD2
-getDrivesStates	KEYWORD2
+decreaseVolume	KEYWORD2
+fastBackwardDuration	KEYWORD2
+fastForwardDuration	KEYWORD2
 getDrive	KEYWORD2
-setDrive	KEYWORD2
+getDrivesStates	KEYWORD2
+getDuration	KEYWORD2
+getFileName	KEYWORD2
 getFileNumber	KEYWORD2
-getTotalFiles	KEYWORD2
-playLastInDirectory	KEYWORD2
-playNextDirectory	KEYWORD2
 getFirstFileNumberInCurrentDirectory	KEYWORD2
+getRuntime	KEYWORD2
+getStatus	KEYWORD2
+getTotalFiles	KEYWORD2
 getTotalFilesInCurrentDirectory	KEYWORD2
 increaseVolume	KEYWORD2
-decreaseVolume	KEYWORD2
 insertFileByNumber	KEYWORD2
-stopInsertedFile	KEYWORD2
+pause	KEYWORD2
+play	KEYWORD2
+playCombined	KEYWORD2
+playFileByName	KEYWORD2
+playFileByNumber	KEYWORD2
+playLastInDirectory	KEYWORD2
+playNext	KEYWORD2
+playNextDirectory	KEYWORD2
+playPrevious	KEYWORD2
+prepareFileByNumber	KEYWORD2
+repeatPart	KEYWORD2
+setChannel	KEYWORD2
 setDirectory	KEYWORD2
+setDrive	KEYWORD2
+setEqualizer	KEYWORD2
 setLoopMode	KEYWORD2
 setRepeatLoops	KEYWORD2
-playCombined	KEYWORD2
+setVolume	KEYWORD2
+startSendingRuntime	KEYWORD2
+stop	KEYWORD2
 stopCombined	KEYWORD2
-setChannel	KEYWORD2
-getFileName	KEYWORD2
-prepareFileByNumber	KEYWORD2
-repeatPart	KEYWORD2
+stopInsertedFile	KEYWORD2
 stopRepeatPart	KEYWORD2
-fastBackwardDuration	KEYWORD2
-fastForwardDuration	KEYWORD2
-getDuration	KEYWORD2
-startSendingRuntime	KEYWORD2
-getRuntime	KEYWORD2
 stopSendingRuntime	KEYWORD2
 
 #######################################
 # Constants (LITERAL1)
 #######################################
 
-STATUSUNKNOWN	LITERAL1
 CHANNELMP3	LITERAL1
-CHANNELDAC	LITERAL1
+CHANNELAUX	LITERAL1
 CHANNELMP3AUX	LITERAL1
 CHANNELUNKNOWN	LITERAL1
 DRIVEUSB	LITERAL1
 DRIVESD	LITERAL1
 DRIVEFLASH	LITERAL1
+DRIVENO	LITERAL1
 DRIVEUNKNOWN	LITERAL1
 LOOPBACKALL	LITERAL1
 SINGLEAUDIOLOOP	LITERAL1
diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
-name=DRF0534
-version=1.0.0
+name=DFR0534
+version=1.0.1
 author=codingABI
 maintainer=codingABI
 sentence=Class for controlling a DFR0534 audio module by SoftwareSerial
diff --git a/src/DFR0534.cpp b/src/DFR0534.cpp
diff --git a/src/DFR0534.h b/src/DFR0534.h
