feat: add cold start ready sound feature

Author: fhirschmann

html/locales/de.json

@@ -423,7 +423,8 @@
 			"recoverVolBoot": "Letzte Lautstärke bei Neustart verwenden",
 			"recoverVolBootExp": "Die Box erinnert sich über einen Neustart hinweg, welche Lautstärke zuletzt verwendet wurde und stellt diese automatisch wieder ein.",
 			"volumeCurve": "Feinere Abstufungen bei niedriger Lautstärke",
-			"volumeCurveExp": "Verwendung von logarithmischer Lautstärkeberechnung. Kann helfen, wenn im unteren Lautstärkebereich die Abstufungen zu grob sind."
+			"volumeCurveExp": "Verwendung von logarithmischer Lautstärkeberechnung. Kann helfen, wenn im unteren Lautstärkebereich die Abstufungen zu grob sind.",
+			"readypath": "Pfad zur Begrüßungs-MP3 (Kaltstart)"
 		},
 		"neopixel": {
 			"title": "Neopixel (Helligkeit)",

html/locales/en.json

@@ -425,7 +425,8 @@
 			"recoverVolBoot": "Use last volume at restart",
 			"recoverVolBootExp": "After a restart, the speaker remembers which volume was last used and automatically adjusts it again.",
 			"volumeCurve": "Finer gradations at low volume",
-			"volumeCurveExp": "Use of logarithmic volume calculation. Can help if the gradations in the lower volume range are too coarse."
+			"volumeCurveExp": "Use of logarithmic volume calculation. Can help if the gradations in the lower volume range are too coarse.",
+			"readypath": "Path to ready MP3 (cold start)"
 		},
 		"neopixel": {
 			"title": "Neopixel (brightness)",

html/locales/fr.json

@@ -412,7 +412,8 @@
 			"recoverVolBoot": "Utiliser le dernier volume au redémarrage",
 			"recoverVolBootExp": "Le boîtier se souvient, après un redémarrage, du dernier volume utilisé et le rétablit automatiquement.",
 			"volumeCurve": "Des nuances plus fines à faible volume",
-			"volumeCurveExp": "Utilisation du calcul logarithmique du volume. Peut aider si les nuances sont trop grossières dans la plage de volume inférieure."
+			"volumeCurveExp": "Utilisation du calcul logarithmique du volume. Peut aider si les nuances sont trop grossières dans la plage de volume inférieure.",
+			"readypath": "Chemin vers le MP3 de bienvenue"
 		},
 		"neopixel": {
 			"title": "Neopixel (luminosité)",

html/management.html

@@ -1063,6 +1063,9 @@ <h5 class="modal-title" data-i18n="tools.nvs.erase.title"></h5>
 									data-i18n="[data-bs-content]general.options.volumeCurveExp" tabindex="0"><i
 										class="fas fa-circle-question"></i></a>
 							</div>
+							<br>
+							<label for="readyPath" data-i18n="general.options.readypath"></label>
+							<input type="text" class="form-control" id="readyPath" name="readyPath">
 						</fieldset>
 					</div>
 					<div class="col-md-12 mb-4" id="neopixelConfig" data-visible="false">
@@ -2555,6 +2558,9 @@ <h5 class="modal-title" data-i18n="tools.nvs.erase.title"></h5>
 				if (genSettings.mfrc522Gain !== undefined) {
 					document.getElementById('mfrc522Gain').value = genSettings.mfrc522Gain;
 				}
+				if (genSettings.readyPath !== undefined) {
+					document.getElementById('readyPath').value = genSettings.readyPath;
+				}
 			}
 			// current values
 			let currSettings = settings.current;
@@ -2971,7 +2977,8 @@ <h5 class="modal-title" data-i18n="tools.nvs.erase.title"></h5>
 					rfidReaderType: Number($('#rfidReaderType').val()),
 					pn5180Lpcd: $('#pn5180Lpcd').prop('checked'),
 					slix2Password: $('#slix2Password').val(),
-					mfrc522Gain: Number($('#mfrc522Gain').val())
+					mfrc522Gain: Number($('#mfrc522Gain').val()),
+					readyPath: document.getElementById('readyPath').value
 				},
 				"led": {
 					initBrightness: Number($('#initBrightness').val()),

src/AudioPlayer.cpp

@@ -629,7 +629,6 @@ void AudioPlayer_Loop() {
 		if (newPlayListAvailable) {
 			newPlayListAvailable = false;
 			audio->stopSong();
-			Rfid_ResetOldRfid();
 
 			// destroy the old playlist and assign the new one
 			freePlaylist(gPlayProperties.playlist);
@@ -1233,6 +1232,18 @@ void AudioPlayer_PauseOnMinVolume(const uint8_t oldVolume, const uint8_t newVolu
 	}
 }
 
+void AudioPlayer_PlayReadyMsg(void) {
+	if (audio != nullptr) {
+		String path = gPrefsSettings.getString("readyPath", "/ready.mp3");
+		if (path.length() > 0 && gFSystem.exists(path)) {
+			Log_Printf(LOGLEVEL_INFO, "Audio: Playing ready sound from %s", path.c_str());
+			audio->connecttoFS(gFSystem, path.c_str());
+		} else {
+			Log_Printf(LOGLEVEL_NOTICE, "Audio: Ready sound not found at %s", path.c_str());
+		}
+	}
+}
+
 // Receives de-serialized RFID-data (from NVS) and dispatches playlists for the given
 // playmode to the track-queue.
 void AudioPlayer_SetPlaylist(const char *_itemToPlay, const uint32_t _lastPlayPos, const uint32_t _playMode, const uint16_t _trackLastPlayed) {

src/AudioPlayer.h

@@ -71,6 +71,7 @@ void AudioPlayer_SetEqualizer(const int8_t gainLowPass, const int8_t gainBandPas
 void AudioPlayer_SetPlaylist(const char *_itemToPlay, const uint32_t _lastPlayPos, const uint32_t _playMode, const uint16_t _trackLastPlayed);
 void AudioPlayer_SetTrackControl(const uint8_t trackCommand);
 void AudioPlayer_PauseOnMinVolume(const uint8_t oldVolume, const uint8_t newVolume);
+void AudioPlayer_PlayReadyMsg(void);
 
 playlistSortMode AudioPlayer_GetPlaylistSortMode(void);
 bool AudioPlayer_SetPlaylistSortMode(playlistSortMode value);

src/Mqtt.cpp

@@ -456,6 +456,7 @@ void Mqtt_ClientCallback(const char *topic_buf, uint32_t topic_length, const cha
 		// New track to play? Take RFID-ID as input
 		else if (reduced_topic_str == topicRfid) {
 			if (payload_str.size() >= (cardIdStringSize - 1)) {
+				Rfid_ResetOldRfid();
 				xQueueSend(gRfidCardQueue, payload_str.data(), 0);
 			} else {
 				System_IndicateError();

src/System.cpp

@@ -309,6 +309,10 @@ void System_ShowWakeUpReason() {
 	}
 }
 
+bool System_IsColdStart() {
+	return (esp_sleep_get_wakeup_cause() == ESP_SLEEP_WAKEUP_UNDEFINED);
+}
+
 void System_esp_print_tasks(void) {
 #ifdef CONFIG_FREERTOS_USE_TRACE_FACILITY
 	char *pbuffer = x_calloc(2048, 1);

src/System.h

@@ -28,3 +28,4 @@ uint8_t System_GetOperationModeFromNvs(void);
 void System_esp_print_tasks(void);
 void System_ShowWakeUpReason();
 void System_PauseTasksDuringUpload(bool pause);
+bool System_IsColdStart();

src/Web.cpp

@@ -688,6 +688,13 @@ WebsocketCodeType JSONToSettings(JsonObject doc) {
 		success = success && (gPrefsSettings.putBool("pauseOnMinVol", generalObj["pauseOnMinVol"].as<bool>()) != 0);
 		success = success && (gPrefsSettings.putBool("recoverVolBoot", generalObj["recoverVolBoot"].as<bool>()) != 0);
 		success = success && (gPrefsSettings.putUChar("volumeCurve", generalObj["volumeCurve"].as<uint8_t>()) != 0);
+		if (generalObj["readyPath"].is<const char *>()) {
+			const char *path = generalObj["readyPath"].as<const char *>();
+			size_t written = gPrefsSettings.putString("readyPath", path);
+			if (strlen(path) > 0 && written == 0) {
+				success = false;
+			}
+		}
 		success = success && (gPrefsRfid.putUChar("rfidReaderType", generalObj["rfidReaderType"].as<uint8_t>()) != 0);
 		success = success && (gPrefsRfid.putBool("pn5180Lpcd", generalObj["pn5180Lpcd"].as<bool>()) != 0);
 		if (generalObj["slix2Password"].is<const char *>()) {
@@ -1049,6 +1056,7 @@ static void settingsToJSON(JsonObject obj, const String section) {
 		generalObj["pauseOnMinVol"].set(gPrefsSettings.getBool("pauseOnMinVol", false)); // PAUSE_ON_MIN_VOLUME
 		generalObj["recoverVolBoot"].set(gPrefsSettings.getBool("recoverVolBoot", false)); // USE_LAST_VOLUME_AFTER_REBOOT
 		generalObj["volumeCurve"].set(gPrefsSettings.getUChar("volumeCurve", 0)); // VOLUMECURVE
+		generalObj["readyPath"].set(gPrefsSettings.getString("readyPath", "/ready.mp3")); // READY_PATH
 	}
 	if ((section == "") || (section == "equalizer")) {
 		// equalizer settings