Updates for v1.0.3

codingABI · codingABI · commit cd7b87e6a465 · 2024-10-17T17:29:16.000+02:00
Comment changes, small fixes in docu, update doxygen
diff --git a/DFR0534.pdf b/DFR0534.pdf
diff --git a/README.md b/README.md
@@ -80,8 +80,8 @@ For function details see comments in [DFR0534.cpp](src/DFR0534.cpp)
 Minimal schematic to use this library
 | Pin  | Connected to |
 | ------------- | ------------- |
-| TX | Used SoftwareSerial RX  |
-| RX | Used SoftwareSerial TX* |
+| TX | SoftwareSerial RX  |
+| RX | SoftwareSerial TX* |
 | GND | Ground  |
 | VCC | 3.3-5V  |
 | SP+ | Speaker + connector |
diff --git a/examples/playFileByName/playFileByName.ino b/examples/playFileByName/playFileByName.ino
@@ -37,7 +37,7 @@ void setup() {
    * - "/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*" for first audio file matching /10*.*
    * - "/10      /20      WAV" for the file /10/20.wav
    * - first means first in copy order
    *
diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=DFR0534
-version=1.0.2
+version=1.0.3
 author=codingABI
 maintainer=codingABI
 sentence=Class for controlling a DFR0534 audio module by SoftwareSerial
diff --git a/src/DFR0534.cpp b/src/DFR0534.cpp
@@ -38,7 +38,7 @@
  * @author codingABI https://github.com/codingABI/
  * @copyright 2-Clause BSD License
  * @file DFR0534.cpp
- * @version 1.0.2
+ * @version 1.0.3
  */
 #include "DFR0534.h"
 
@@ -238,12 +238,13 @@ void DFR0534::playNext()
  *   are allowed and can be used to reduce the filling space chars
  * 
  * Valid examples:
- * - "/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' (in this order for example: sun0.mp3 sun.mp3 sun1.mp3) 
- * - "/99-AFR*MP3" for first file matching /99-Afr*.mp3
+ * - "/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 means first in copy order
  *
  * @param[in] path   Full path of the audio file
  * @param[in] drive  Drive, where file is stored: Drive DFR0534::DRIVEUSB, DFR0534::DRIVESD or DFR0534::DRIVEFLASH (=default)
diff --git a/src/DFR0534.h b/src/DFR0534.h
@@ -14,12 +14,12 @@
  * @author codingABI https://github.com/codingABI/
  * @copyright 2-Clause BSD License
  * @file DFR0534.h
- * @version 1.0.2
+ * @version 1.0.3
  */
 #pragma once
 
 /** Library version */
-#define DFR0534_VERSION "1.0.2"
+#define DFR0534_VERSION "1.0.3"
 
 #include <Arduino.h>
 #include <Stream.h>

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ void setup() {`
`37`	`37`	`* - "/99-AFR~1MP3" for a file '/99-Africa.mp3'`
`38`	`38`	`* - "/SUNMP3" for first file matching /sun.mp3, for example '/sun.mp3'`
`39`	`39`	`* - "/99-AFRMP3" for first file matching '/99-Afr.mp3'`
`40`		`- * - "/10" for first audio file matching /10.`
	`40`	`+ * - "/10" for first audio file matching /10.*`
`41`	`41`	`* - "/10 /20 WAV" for the file /10/20.wav`
`42`	`42`	`* - first means first in copy order`
`43`	`43`	`*`