Merge pull request #2 from s-light/main

small tweaks

Author: codingABI

examples/playFileByName/playFileByName.ino

@@ -19,29 +19,33 @@ void setup() {
   // Set volume
   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:
+  /* 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.
+   * - maximal 8 characters
+   * - Every file and folder whose name length is shorter then 8 chars 
+   *   must be filled up to the 8 chars length by spaces.
+   * - must end with WAV or MP3
    * - Only WAV and MP3 files are supported
-   * Wildcards * (=multiple arbitrary characters) and ? (=one single arbitrary character) 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*.*
+   * - "/01      WAV" for file '/01.wav'
+   * - "/99-AFR~1MP3" for a file '/99-Africa.mp3'
+   * - "/SUN*MP3" for first* file matching /sun*.mp3, for example '/sun.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
+   * - first* in this order for example: 
+   *     sun0.mp3 sun.mp3 sun1.mp3
    *
-   * You can get example files from https://github.com/codingABI/DFR0534/tree/main/assets/exampleContent
-   *
-   * 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
    */
 
   // Play the file "test.wav"

library.properties

@@ -1,5 +1,5 @@
 name=DFR0534
-version=1.0.1
+version=1.0.2
 author=codingABI
 maintainer=codingABI
 sentence=Class for controlling a DFR0534 audio module by SoftwareSerial

src/DFR0534.cpp

@@ -38,7 +38,7 @@
  * @author codingABI https://github.com/codingABI/
  * @copyright 2-Clause BSD License
  * @file DFR0534.cpp
- * @version 1.0.1
+ * @version 1.0.2
  */
 #include "DFR0534.h"
 

src/DFR0534.h

@@ -14,14 +14,14 @@
  * @author codingABI https://github.com/codingABI/
  * @copyright 2-Clause BSD License
  * @file DFR0534.h
- * @version 1.0.1
+ * @version 1.0.2
  */
 #pragma once
 
 /** Library version */
 #define DFR0534_VERSION "1.0.1"
 
-#include <arduino.h>
+#include <Arduino.h>
 #include <Stream.h>
 
 #define STARTINGCODE 0xAA