forked from renjfk/OpenNeato
-
Notifications
You must be signed in to change notification settings - Fork 1
feat(notifications): cleaning-started ntfy + fix done summary race #2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,6 +10,10 @@ | |
| #define NTFY_DEFAULT_HOST "ntfy.sh" | ||
| #define NTFY_CONNECT_TIMEOUT_MS 3000 | ||
|
|
||
| // Max wall-clock to wait for CleaningHistory::stopCollection's async charger | ||
| // fetch to finalize stats before sending the "done" notification anyway. | ||
| #define NTFY_DONE_PENDING_TIMEOUT_MS 5000 | ||
|
|
||
| NotificationManager::NotificationManager(NeatoSerial& neato, SettingsManager& settings, DataLogger& logger, | ||
| CleaningHistory& history) : | ||
| LoopTask(NOTIF_INTERVAL_IDLE_MS), neato(neato), settings(settings), dataLogger(logger), history(history) { | ||
|
|
@@ -21,6 +25,11 @@ void NotificationManager::begin() { | |
| } | ||
|
|
||
| void NotificationManager::tick() { | ||
| // Drain a pending "done" notification independently of the fetch path — | ||
| // it's waiting on CleaningHistory's async stop, not our own state fetch. | ||
| if (donePending) | ||
| flushPendingDone(); | ||
|
|
||
| if (fetchPending) | ||
| return; | ||
|
|
||
|
|
@@ -52,6 +61,7 @@ void NotificationManager::checkTransitions() { | |
| if (!prevUiState.isEmpty()) { | ||
| bool wasCleaning = prevUiState.indexOf("CLEANINGRUNNING") >= 0; | ||
| bool wasDocking = prevUiState.indexOf("DOCKING") >= 0; | ||
| bool isCleaningRunning = ui.indexOf("CLEANINGRUNNING") >= 0; | ||
| bool isDocking = ui.indexOf("DOCKING") >= 0; | ||
| bool isSuspended = ui.indexOf("CLEANINGSUSPENDED") >= 0; | ||
| bool isIdle = ui == "UIMGR_STATE_IDLE" || ui == "UIMGR_STATE_STANDBY"; | ||
|
|
@@ -66,6 +76,14 @@ void NotificationManager::checkTransitions() { | |
| // The UI state transitions DOCKING -> CLEANINGSUSPENDED once on the dock. | ||
| bool isRecharging = rs.indexOf("Charging_Cleaning") >= 0; | ||
|
|
||
| // Fresh start: idle -> CLEANINGRUNNING (excludes resume from | ||
| // pause/suspended and resume after mid-clean recharge dock). | ||
| bool prevInCleaningContext = prevUiState.indexOf("CLEANING") >= 0 || | ||
| prevUiState.indexOf("DOCKING") >= 0; | ||
| if (isCleaningRunning && !prevInCleaningContext && cfg.ntfyOnStart) { | ||
| sendNotification(topic, "arrow_forward", hostname + ": Cleaning started"); | ||
| } | ||
|
|
||
| if (isDocking && !wasDocking && isRecharging && cfg.ntfyOnDocking) { | ||
| // Recharge dock — robot will resume cleaning after charging | ||
| sendNotification(topic, "electric_plug", hostname + ": Returning to base to recharge"); | ||
|
|
@@ -75,19 +93,17 @@ void NotificationManager::checkTransitions() { | |
| // Also handle suspended -> idle (user stops clean while recharging). | ||
| bool dockingDone = wasDocking && wasCleaningBeforeDock && !isRecharging; | ||
| bool suspendedDone = (prevUiState.indexOf("CLEANINGSUSPENDED") >= 0) && wasCleaningBeforeDock; | ||
| if ((wasCleaning || dockingDone || suspendedDone) && isIdle && cfg.ntfyOnDone) { | ||
| String msg = hostname + ": Cleaning done"; | ||
| const LastCleanStats& stats = history.getLastCleanStats(); | ||
| if (stats.valid) { | ||
| long mins = stats.durationSec / 60; | ||
| msg += "\n" + String(mins) + "min"; | ||
| msg += " | " + String(stats.areaCoveredM2, 1) + "m2"; | ||
| msg += " | " + String(stats.distanceM, 0) + "m"; | ||
| if (stats.batteryStart >= 0 && stats.batteryEnd >= 0) { | ||
| msg += " | " + String(stats.batteryStart) + "% -> " + String(stats.batteryEnd) + "%"; | ||
| } | ||
| } | ||
| sendNotification(topic, "white_check_mark", msg); | ||
| if ((wasCleaning || dockingDone || suspendedDone) && isIdle && cfg.ntfyOnDone && !donePending) { | ||
| // Defer the send: CleaningHistory::stopCollection finalizes stats | ||
| // inside an async getCharger callback, so reading getLastCleanStats() | ||
| // here can race and pull stale data from the prior session. Capture | ||
| // the current sessionId; flushPendingDone() fires once it increments | ||
| // (or after NTFY_DONE_PENDING_TIMEOUT_MS). | ||
| donePending = true; | ||
| doneTriggerSessionId = history.getLastCleanStats().sessionId; | ||
| donePendingSinceMs = millis(); | ||
| doneHostname = hostname; | ||
| doneTopic = topic; | ||
| } | ||
|
|
||
| // Clear tracking flag when leaving docking — but preserve it | ||
|
|
@@ -126,6 +142,34 @@ bool NotificationManager::isActiveState(const String& uiState) { | |
| uiState.indexOf("CLEANINGSUSPENDED") >= 0 || uiState.indexOf("DOCKING") >= 0; | ||
| } | ||
|
|
||
| void NotificationManager::flushPendingDone() { | ||
| const LastCleanStats& stats = history.getLastCleanStats(); | ||
| bool finalized = stats.sessionId != doneTriggerSessionId; | ||
| bool timedOut = (millis() - donePendingSinceMs) >= NTFY_DONE_PENDING_TIMEOUT_MS; | ||
| if (!finalized && !timedOut) | ||
| return; | ||
|
|
||
| // If stopCollection finalized after we triggered, sessionId moved and stats | ||
| // are fresh; if we timed out, fire bare without stats rather than stale. | ||
| sendDoneNotification(doneTopic, doneHostname, finalized && stats.valid); | ||
| donePending = false; | ||
|
Comment on lines
+145
to
+155
|
||
| } | ||
|
|
||
| void NotificationManager::sendDoneNotification(const String& topic, const String& hostname, bool withStats) { | ||
| String msg = hostname + ": Cleaning done"; | ||
| if (withStats) { | ||
| const LastCleanStats& stats = history.getLastCleanStats(); | ||
| long mins = stats.durationSec / 60; | ||
| msg += "\n" + String(mins) + "min"; | ||
| msg += " | " + String(stats.areaCoveredM2, 1) + "m2"; | ||
| msg += " | " + String(stats.distanceM, 0) + "m"; | ||
| if (stats.batteryStart >= 0 && stats.batteryEnd >= 0) { | ||
| msg += " | " + String(stats.batteryStart) + "% -> " + String(stats.batteryEnd) + "%"; | ||
| } | ||
| } | ||
| sendNotification(topic, "white_check_mark", msg); | ||
| } | ||
|
|
||
| void NotificationManager::sendNotification(const String& topic, const String& tags, const String& message) { | ||
| LOG("NOTIF", "Sending: [%s] %s", tags.c_str(), message.c_str()); | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The deferred "done" flow relies on
flushPendingDone()being called again withinNTFY_DONE_PENDING_TIMEOUT_MS(5s), but after the UI becomes idle this same tick sets the LoopTask interval toNOTIF_INTERVAL_IDLE_MS(30s). That means the pending notification may not flush for ~30s (and the 5s timeout is ineffective), causing delayed or bare "done" notifications. Consider temporarily forcing a short interval whiledonePendingis true (or using a separate fast ticker) and restoring the normal active/idle interval once the pending notification is flushed.