Dev

.git-blame-ignore-revs

@@ -3,3 +3,6 @@ d1f82a7c93f160f9197c8b4e14e5a984ac6f9449
 
 # Code re-formatting with editorconf
 3a562b67e3ca0f98ed128650440323c3b2d5fc78
+
+# Code re-formatting for html+json
+ee16ea64767c28420d3711bfe7b4a81c71f1e8bf

.gitignore

@@ -15,3 +15,8 @@ sdkconfig.*
 src/settings-override.h
 src/settings-custom-override.h
 node_modules/
+html/REST_API.yaml
+html/*.min.html
+html/locales/*.min.json
+html/js/*.min.min.js
+html/js/swaggerInitializer.min.js

README.md

@@ -138,7 +138,7 @@ needs one GPIO less. So basically it's a no-brainer.
 RC522 is so to say the ESPuino standard. It's cheap and works, but RFID tags have to be placed close
 to the reader. PN5180 instead has better RFID range/sensitivity and can read ISO-15693 / iCode
 SLIX2-tags aka 'Tonies' (you need a password to read Tonies), too. You can also wake up ESPuino with
-the a ISO-14443 card (after flashing PN5180 with a new firmware). This feature is called LPCD.
+the a RFID tag (after flashing PN5180 with a new firmware). This feature is called LPCD.
 Disadvantages PN5180: it's more expensive and needs more GPIOs (6/7 instead of 4). In my opinion
 it's worth it! Refer to PN5180's wiring section below for further information. Hint: if using 3.3 V
 only make sure to connect these 3.3 V to PN5180's 5 V AND 3.3 V. Sounds weird but it's necessary.
@@ -260,11 +260,11 @@ It's not just simply playing music; different playback modes are supported:
 - `Audiobook`=> single file or playlist/folder; last play position (file and playlist) is saved
   (when pushing pause or moving to another track) and reused next time
 - `Audiobook (loop)` => same as audiobook but loops forever
-- `Folder/playlist (alph. sorted)` => plays all tracks in alph. order from a folder one time
+- `Folder/playlist (sorted)` => plays all tracks in order from a folder one time
 - `Folder/playlist (random order)` => plays all tracks in random order from a folder one time
-- `Folder/playlist (alph. sorted)` => plays all tracks in alph. order from a folder forever
+- `Folder/playlist (sorted)` => plays all tracks in order from a folder forever
 - `Folder/playlist (random order)` => plays all tracks in random order from a folder forever
-- `All tracks of a random subdirectory (sorted alph.)` => plays of tracks in alph. order of a
+- `All tracks of a random subdirectory (sorted)` => plays of tracks in order of a
   randomly picked subdirectory of a given directory
 - `All tracks of a random subdirectory (random order)` => plays all tracks in random order of a
   randomly picked subdirectory of a given directory
@@ -373,6 +373,12 @@ Most designs use a Neopixel ring, but a linear strip is also possible.
 - **Previous** (long; keep pressed) + **Next** (short) + release (both): toggle WiFi
   enabled/disabled
 
+#### Virtual RFID cards
+
+Any of the button actions can also be assigned to virtual RFID cards.
+Those cards then can be assigned on the web GUI like normal cards.
+To select a virtual RFID card, just press the configured button action, the virtual RFID automatically gets filled in in the web GUI.
+
 ### Music playback
 
 - Music starts to play right away after a valid RFID tag was applied (if it's known to ESPuino).

REST-API.yaml

@@ -2,12 +2,16 @@ openapi: 3.0.0
 info:
   title: ESPuino API
   version: 1.0.5
-  description: API for the ESPuino, a DIY Smart Speaker project. ESPuino is a DIY Smart Speaker that uses software-based audio decoding, supports various music sources, and offers a user-friendly web interface. It simplifies audio processing and enhances user feedback with Neopixel rings.
-
+  description: >-
+    API for the ESPuino, a DIY Smart Speaker project. ESPuino is a DIY Smart
+    Speaker that uses software-based audio decoding, supports various music
+    sources, and offers a user-friendly web interface. It simplifies audio
+    processing and enhances user feedback with Neopixel rings.
 servers:
-  - url: http://espuino.local/
+  - url: /
+    description: Local Device
+  - url: 'http://espuino.local/'
     description: Development ESPuino
-
 paths:
   /explorer:
     get:
@@ -18,7 +22,7 @@ paths:
           name: path
           schema:
             type: string
-            default: "/"
+            default: /
           description: Path to the directory to be listed.
       responses:
         '200':
@@ -32,9 +36,11 @@ paths:
                   properties:
                     name:
                       type: string
-                    isDir:
+                    dir:
                       type: boolean
-                      description: True if item is a directory.
+                      description: >-
+                        True if item is a directory. This parameter is omitted
+                        for a file.
     post:
       summary: Upload a file to a directory.
       description: Upload a file to the specified directory.
@@ -245,7 +251,7 @@ paths:
   /settings:
     get:
       summary: Get common settings.
-      description: Get common settings, optionally for a specific section.
+      description: 'Get common settings, optionally for a specific section.'
       parameters:
         - in: query
           name: section
@@ -261,6 +267,7 @@ paths:
                 type: object
                 properties:
                   # Include your common settings properties here.
+                  null
     post:
       summary: Save settings.
       description: Save common settings.
@@ -304,7 +311,9 @@ paths:
   /rfid:
     get:
       summary: List all saved RFID-tag assignments with details.
-      description: Get a list of saved RFID-tag assignments with details. Optionally, provide an ID to list only a single assignment.
+      description: >-
+        Get a list of saved RFID-tag assignments with details. Optionally,
+        provide an ID to list only a single assignment.
       parameters:
         - in: query
           name: id
@@ -322,6 +331,7 @@ paths:
                   type: object
                   properties:
                     # Include your RFID-tag assignment properties here.
+                    null
     post:
       summary: Save or overwrite RFID-tag assignment.
       description: Save a new RFID-tag assignment or overwrite an existing one.
@@ -372,7 +382,6 @@ paths:
                 type: array
                 items:
                   type: string
-
   /cover:
     get:
       summary: Get album cover image.
@@ -385,7 +394,6 @@ paths:
               schema:
                 type: string
                 format: binary
-
   /info:
     get:
       summary: Get common information.
@@ -399,7 +407,7 @@ paths:
                 type: object
                 properties:
                   # Include your common information properties here.
-
+                  null
   /log:
     get:
       summary: Get current log.
@@ -411,7 +419,6 @@ paths:
             text/plain:
               schema:
                 type: string
-
   /stats:
     get:
       summary: Get task runtime information.
@@ -423,7 +430,6 @@ paths:
             text/html:
               schema:
                 type: string
-
   /debug:
     get:
       summary: Get debug information.
@@ -437,51 +443,69 @@ paths:
                 type: object
                 properties:
                   # Include your debug information properties here.
-
+                  null
   /upload:
     post:
       summary: Upload NVS backup.
       description: Uploads a NVS backup file.
       responses:
         '200':
           description: Successful response for NVS backup upload.
-
+      requestBody:
+        required: true
+        content:
+          multipart/form-data:
+            schema:
+              type: object
+              properties:
+                file:
+                  type: string
+                  format: binary
   /update:
     post:
       summary: Upload new firmware.
-      description: Uploads new firmware to ESPuino.
+      description: Uploads new firmware to ESPuino. Make sure to restart afterwards.
       responses:
         '200':
           description: Successful response for firmware update.
-
+      requestBody:
+        required: true
+        content:
+          multipart/form-data:
+            schema:
+              type: object
+              properties:
+                firmwareUpload:
+                  type: string
+                  format: binary
   /restart:
     post:
       summary: Restart ESPuino.
       description: Performs a restart of ESPuino. No parameters required.
       responses:
         '200':
           description: Successful response for ESPuino restart.
-
   /shutdown:
     post:
       summary: Shutdown ESPuino.
       description: Performs a shutdown (deep-sleep) of ESPuino. No parameters required.
       responses:
         '200':
           description: Successful response for ESPuino shutdown.
-
   /rfidnvserase:
     post:
       summary: Erase RFID assignments from NVS.
       description: Erases all RFID assignments from NVS.
       responses:
         '200':
           description: Successful response for RFID assignments erasure.
-
   /wifiscan:
     get:
       summary: Get nearby WiFi networks.
-      description: Get a list of available nearby WiFi networks. The first request will return 0 results unless you start the scan from somewhere else (loop/setup). Do not request more often than 3-5 seconds!
+      description: >-
+        Get a list of available nearby WiFi networks. The first request will
+        return 0 results unless you start the scan from somewhere else
+        (loop/setup). Do not request more often than 3-5 seconds!
       responses:
         '200':
           description: Successful response with nearby WiFi networks.
@@ -491,11 +515,10 @@ paths:
                 type: array
                 items:
                   type: string
-
   /trackprogress:
     get:
       summary: Get current track progress.
-      description: Get current track progress, time, and duration.
+      description: 'Get current track progress, time, and duration.'
       responses:
         '200':
           description: Successful response with track progress information.
@@ -505,11 +528,11 @@ paths:
                 type: object
                 properties:
                   # Include your track progress information properties here.
-
+                  null
   /inithalleffectsensor:
     get:
       summary: Initialize Hall Effect Sensor Value.
       description: Initializes the Hall Effect Sensor Value.
       responses:
         '200':
-          description: Successful response for initializing Hall Effect Sensor Value.
+          description: Successful response for initializing Hall Effect Sensor Value.

changelog.md

@@ -1,6 +1,61 @@
 # Changelog
 
 
+## Version 2.2 (17.01.2024)
+
+* 19.09.2024: Document the virtual cards in the UI #333, thanks to @caco3 !
+* 18.09.2024: Re-designed tools page (#337), thanks to @caco3 !
+* 16.09.2024: Fix sleep after playlist not toggling nightmode #336, thanks to @dneukirchen !
+* 12.09.2024: PlatformIO package 6.8.1 (Arduino 2.0.17, ESP-IDF 4.4.7)
+* 12.09.2024: Change default settings to match "ESPuino-mini 4Layer" board
+* 11.09.2024: Fix string's expected length for rfid-cmnd via mqtt
+* 11.09.2024: Ignore mqtt messages with length zero
+* 10.09.2024: Porting to new web server library completed
+* 09.06.2024: Consume about 50% less CPU time in Audio library
+* 09.06.2024: Replace 3rd party library toastr (#331), thanks to @trainbird !
+* 09.06.2024: Modernized webserver & optimized JSON delivery (#332)
+* 20.05.2024: PlatformIO package 6.7.0 (Arduino 2.0.16, ESP-IDF 4.4.7)
+* 20.05.2024: Disable bluetooth support for A1S (IRAM too small)
+* 09.05.2024: Upgrade to Bootstrap v5.0 + Web-UI Enhancements (#328), thanks to @caco3 !
+* 23.04.2024: Enhance UI minification (#323), thanks to @caco3 ! 
+* 22.04.2024: Added virtual RFID-Cards (#319), thanks to @caco3 ! 
+* 18.04.2024: Correct calculation of newFilePos for SEEK_POS_PERCENT, thanks to @sfields!
+* 18.04.2024: Correct calculation of gPlayProperties.currentRelPos, thanks to @sfields!
+* 18.04.2024: Get title from-VORBISCOMMENT and ID3, thanks to @sfields!
+* 18.04.2024: Correct log for SSID name, thanks to @sfields!
+* 18.04.2024: Add button to expand/shrink file list (#317), thanks to @caco3 !
+* 18.04.2024: Fix remote UI debugging (#316), thanks to @caco3 !
+* 14.04.2024: Embed swagger UI #314, thanks to @caco3 !
+* 07.04.2024: Equalizer settings to WebUI #313, thanks to @trainbird !
+* 28.03.2024: Audio lib, fix a memory leak with flac files
+* 28.03.2024: Fix some warnings with upcoming Arduino 3 (ESP-IDF v5.1)
+* 16.03.2024: Reduce memory usage by measurement of JSON payload length
+* 15.03.2024: MQTT receive: Bug fix and avoid payload copy (#309), thanks to @eikel
+* 15.03.2024: Add coverimage support for ogg, vorbis, opus (and some flac), thanks to @sfields ! 
+* 19.02.2024: Add coverimage support for M4A files in Web-UI
+* 18.02.2024: Add coverimage support for flac files in Web-UI, thanks to @sfields ! 
+* 15.02.2024: Rework playlist generation (#275), thanks to @laszloh ! 
+* 15.02.2024: Update sorting strings (#306), thanks to @freddy36 !
+* 15.02.2024: Set title and navbar heading to hostname (#305), thanks to @freddy36 ! 
+* 15.02.2024: Include mac address in info (#304), thanks to @freddy36 !  
+* 12.02.2024: Use natural sort (#296), thanks to @freddy36 !
+* 09.02.2024: Remove explorerCreateParentDirectories (#301), thanks to @freddy36 !
+* 08.02.2024: Remove convertFilenameToAscii (#298), Playlist fixes (#299), thanks to @freddy36 !
+* 08.02.2024: Apple touch icon
+* 07.02.2024: Fix dangling pointer in explorerHandleFileStorageTask (#297), thanks to @freddy36 !
+* 07.02.2024: Reduce WiFi memory consumption (#295), thanks to @laszloh !
+* 05.02.2024: Increase JSON buffer for /debug endpoint
+* 02.02.2024: Improve progress calculation/indication, thanks to @freddy36 !
+* 01.02.2024: Use NVS interator when reading RFID keys, save 4KB RAM , thanks to @laszloh !
+* 01.02.2024: Use dynamically allocated buffer for file upload, save 32KB RAM , thanks to @laszloh !
+* 30.01.2024: Add French Language (#292), thanks to @damda58 !
+* 30.01.2024: Fix some audio dropouts with high-quality OPUS files
+* 30.01.2024: Keep original mtime for gzip compressed files, avoiding uneccesary Web.o rebuilds (#293), thanks to @freddy36 !
+* 23.01.2024: Updated documentation on LPCD setting, thanks to @derpicknicker1 !
+* 21.01.2024: Build (tag 2.2) is broken when NEOPIXEL_ENABLE is not set #289, thanks to @RolinBert !
+* 21.01.2024: PN5180: Save about 500 Bytes of RAM
+
+
 ## Version 2.2 (17.01.2024)
 
 * 14.01.2024: Modify CMD_DIMM_LEDS_NIGHTMODE to toggle night light mode (#287), thanks to @laszloh !