Optimize library with ESP8266/ESP32 support and more robust serial handling

.github/workflows/arduino-library-workflow.yml

@@ -0,0 +1,46 @@
+name: Arduino Library CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  workflow_dispatch:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: arduino/arduino-lint-action@v1
+        with:
+          library-manager: update
+          compliance: strict
+
+  compile-examples:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        fqbn:
+          - arduino:avr:uno
+          - arduino:avr:mega:cpu=atmega2560
+          - esp8266:esp8266:d1_mini
+          - esp32:esp32:esp32
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: arduino/compile-sketches@v1
+        with:
+          fqbn: ${{ matrix.fqbn }}
+          platforms: |
+            - name: arduino:avr
+              source-url: https://downloads.arduino.cc/packages/package_index.json
+            - name: esp8266:esp8266
+              source-url: https://arduino.esp8266.com/stable/package_esp8266com_index.json
+            - name: esp32:esp32
+              source-url: https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
+          sketch-paths: |
+            - examples
+          libraries: |
+            - source-path: ./
+          verbose: true 

CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [2.0.0] - 2024-04-04
+
+### Added
+- Cross-platform compatibility for Arduino, ESP8266, and ESP32
+- Support for both HardwareSerial and SoftwareSerial interfaces
+- Detailed debug logging capability (enabled via DFPLAYER_DEBUG)
+- ESP-specific optimizations to prevent watchdog timer resets
+- GitHub Actions CI workflow for automated testing
+
+### Changed
+- Complete rewrite of the serial communication handling
+- Implemented robust state machine for packet parsing
+- Eliminated blocking delays, using yield() and short waits
+- Optimized checksum validation and error handling
+- Improved API documentation
+
+### Fixed
+- Resolved frequent ESP8266/ESP32 crashes due to serial buffer overflow
+- Fixed watchdog compatibility issues, preventing unexpected resets
+- Eliminated buffer overflow issues for long-running applications
+
+## [1.0.6] - Prior Version
+- Original DFRobot implementation