Change battery overlay widget to better logic and display

[mops1k]

In this case:

• Do not show time if battery charging
• Battery left time has better format in hours and minutes (looks like: 1h 24min)

Summary by CodeRabbit

• New Features

  • Battery widget shows estimated time remaining as hours and minutes when available and not charging.
  • Overlay value formatting now supports an "h" (hours) unit.

• Bug Fixes

  • More reliable overlay initialization and event wiring to reduce missing or delayed displays.
  • Restored consistent handling of display-level settings (order, time/fps/cpu/ram/gpu/vram/battery).
  • Prevented empty/stale overlays by resetting content before redraw.

• Refactor

  • Streamlined initialization sequencing and event wiring for greater stability.

[coderabbitai]

Walkthrough

OSDManager startup flow restructured: platform init now triggers QueryPlatforms which wires RTSS events and handles any existing AppEntry; Settings wiring expanded to register OnScreenDisplay* handlers; Draw content reinitialized. BatteryWidget caches battery time-left in minutes, detects charging via SystemInformation.PowerStatus, and displays hours/minutes only when not charging.

Changes

Cohort / File(s)	Summary
OSD init, RTSS & settings wiring HandheldCompanion/Managers/OSDManager.cs	Adjusted using directives and formatting; Start defers to a PlatformManager_Initialized handler that calls QueryPlatforms; QueryPlatforms now subscribes RTSS Hooked/Unhooked and processes any existing AppEntry; added PlatformManager_Initialized method; SettingsManager_Initialized now calls QuerySettings which (re)registers OnScreenDisplay* handlers (Order, TimeLevel, FPSLevel, CPULevel, RAMLevel, GPULevel, VRAMLevel, BATTLevel); Content reinitialized before Draw assembly; minor brace/structure refinements.
Battery time, caching & charging detection HandheldCompanion/Managers/Overlay/Widget/BatteryWidget.cs	Adds cached TimeLeftInMinutes accessor and helpers TimeBatteryHours/TimeBatteryMinutes; adds IsBatteryCharging() using SystemInformation.PowerStatus.PowerLineStatus; Build changes (explicit short _level, early exit default case); removes direct TimeSpan display and only shows hours/minutes when time available and device not charging; introduces new private members to store time-left and computed values.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant App
  participant OSDManager
  participant SettingsManager
  participant PlatformManager
  participant RTSS

  App->>OSDManager: Start()
  OSDManager->>SettingsManager: Subscribe Initialized / SettingValueChanged
  alt PlatformManager already initialized
    OSDManager->>OSDManager: QueryPlatforms()
  else
    OSDManager->>PlatformManager: Subscribe Initialized
  end

  PlatformManager-->>OSDManager: Initialized
  OSDManager->>OSDManager: QueryPlatforms()
  note over OSDManager: Wire RTSS Hooked/Unhooked events\nProcess existing AppEntry if present

  rect rgba(200,230,255,0.4)
    OSDManager->>RTSS: Subscribe Hooked/Unhooked
    RTSS-->>OSDManager: Hooked / Unhooked
  end

  SettingsManager-->>OSDManager: Initialized
  OSDManager->>OSDManager: Register OnScreenDisplay* handlers

Loading

sequenceDiagram
  autonumber
  participant UI
  participant BatteryWidget
  participant Platform as PlatformManager

  UI->>BatteryWidget: Build(level)
  BatteryWidget->>Platform: Query LibreHardware time remaining (cached)
  BatteryWidget->>BatteryWidget: Cache TimeLeftInMinutes
  BatteryWidget->>BatteryWidget: IsBatteryCharging (SystemInformation.PowerStatus)
  alt Not charging and time available
    BatteryWidget->>BatteryWidget: Compute hours/minutes
    BatteryWidget-->>UI: Render percent + hh:mm (per display level)
  else
    BatteryWidget-->>UI: Render percent only
  end

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Poem

I twitch my whiskers at evented streams,
Platforms queue up, RTSS lights the beams.
If power's plugged in, I'll quiet the time —
Else hours and minutes softly chime.
Hop, overlay — a rabbit's tidy rhyme. 🐇✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The pull request title "Change battery overlay widget to better logic and display" directly relates to the primary changes in this changeset. The main modifications are in BatteryWidget.cs, which implements improved logic by skipping time display when the battery is charging and enhances the display format by showing remaining time as hours and minutes (e.g., "1h 24min"). While there are also supporting changes in OSDManager.cs, these are infrastructure updates that enable the new battery widget functionality, such as adding the "h" unit handling for formatting. The title is clear, specific, and accurately captures the user-facing improvement that is the focus of this pull request.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ad5ac87 and 4bc7d4c.

📒 Files selected for processing (2)

• HandheldCompanion/Managers/OSDManager.cs (5 hunks)
• HandheldCompanion/Managers/Overlay/Widget/BatteryWidget.cs (1 hunks)

🧰 Additional context used

🧬 Code graph analysis (2)

HandheldCompanion/Managers/Overlay/Widget/BatteryWidget.cs (3)

HandheldCompanion/Managers/PlatformManager.cs (1)

• PlatformManager (11-119)

HandheldCompanion/Platforms/Misc/LibreHardware.cs (3)

• GetBatteryTimeSpan (399-399)
• GetBatteryLevel (397-397)
• GetBatteryPower (398-398)

HandheldCompanion/Managers/OSDManager.cs (7)

• OverlayEntry (383-407)
• OverlayEntry (387-393)
• OverlayEntry (395-398)
• OSDManager (12-336)
• OSDManager (45-49)
• AddElementIfNotNull (235-239)
• AddElementIfNotNull (241-245)

HandheldCompanion/Managers/OSDManager.cs (4)

HandheldCompanion/Managers/ManagerFactory.cs (2)

• ManagerFactory (8-72)
• ManagerFactory (39-59)

HandheldCompanion/Managers/PlatformManager.cs (1)

• PlatformManager (11-119)

HandheldCompanion/Platforms/Misc/RTSS.cs (1)

• AppEntry (171-174)

HandheldCompanion/Managers/SettingsManager.cs (1)

• GetString (221-224)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Build and Release

[coderabbitai]

Actionable comments posted: 1

♻️ Duplicate comments (1)

HandheldCompanion/Managers/Overlay/Widget/BatteryWidget.cs (1)

50-64: Time calculations are correct.

The hour/minute extraction logic is now correct (modulo operation properly preserves minutes). However, see the comment on lines 28-34 regarding the null handling issue.

🧹 Nitpick comments (1)

HandheldCompanion/Managers/Overlay/Widget/BatteryWidget.cs (1)

37-48: LGTM!

The charging detection correctly handles all charging states (6, 7, 8, 9) and uses proper disposal.

The cast on Line 42 is redundant. You can simplify:

-foreach (var o in searcher.Get())
-{
-    var result = (ManagementObject)o;
+foreach (ManagementObject result in searcher.Get())
+{
     if (result["BatteryStatus"] is ushort status)

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4bc7d4c and 20dfdfb.

📒 Files selected for processing (1)

• HandheldCompanion/Managers/Overlay/Widget/BatteryWidget.cs (1 hunks)

🧰 Additional context used

🧬 Code graph analysis (1)

HandheldCompanion/Managers/Overlay/Widget/BatteryWidget.cs (3)

HandheldCompanion/Managers/PlatformManager.cs (1)

• PlatformManager (11-119)

HandheldCompanion/Platforms/Misc/LibreHardware.cs (3)

• GetBatteryTimeSpan (399-399)
• GetBatteryLevel (397-397)
• GetBatteryPower (398-398)

HandheldCompanion/Managers/OSDManager.cs (7)

• OverlayEntry (383-407)
• OverlayEntry (387-393)
• OverlayEntry (395-398)
• OSDManager (12-336)
• OSDManager (45-49)
• AddElementIfNotNull (235-239)
• AddElementIfNotNull (241-245)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Build and Release

🔇 Additional comments (2)

HandheldCompanion/Managers/Overlay/Widget/BatteryWidget.cs (2)

1-1: LGTM!

The import is required for the WMI-based charging detection.

---

7-8: LGTM!

The property correctly retrieves battery time data from LibreHardware.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 20dfdfb and 6655d98.

📒 Files selected for processing (1)

• HandheldCompanion/Managers/OSDManager.cs (6 hunks)

🧰 Additional context used

🧬 Code graph analysis (1)

HandheldCompanion/Managers/OSDManager.cs (4)

HandheldCompanion/Managers/ManagerFactory.cs (2)

• ManagerFactory (8-72)
• ManagerFactory (39-59)

HandheldCompanion/Managers/PlatformManager.cs (1)

• PlatformManager (11-119)

HandheldCompanion/Platforms/Misc/RTSS.cs (1)

• AppEntry (171-174)

HandheldCompanion/Managers/SettingsManager.cs (1)

• GetString (221-224)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Build and Release

[coderabbitai]

⚠️ Potential issue | 🟠 Major

Handle unset overlay level settings without crashing

GetString returns an empty string when a setting is missing. Calling Convert.ToInt16 on that empty string throws a FormatException, so the very first run (or any run with a missing key) will break out of QuerySettings. Please guard the parsing and fall back to 0 (or whatever default you expect) when the setting is blank.

             case "OnScreenDisplayTimeLevel":
-                OverlayTimeLevel = Convert.ToInt16(value);
-                break;
+                {
+                    if (!short.TryParse(Convert.ToString(value), out short level))
+                        level = 0;
+                    OverlayTimeLevel = level;
+                    break;
+                }
             case "OnScreenDisplayFPSLevel":
-                OverlayFPSLevel = Convert.ToInt16(value);
-                break;
+                {
+                    if (!short.TryParse(Convert.ToString(value), out short level))
+                        level = 0;
+                    OverlayFPSLevel = level;
+                    break;
+                }
             case "OnScreenDisplayCPULevel":
-                OverlayCPULevel = Convert.ToInt16(value);
-                break;
+                {
+                    if (!short.TryParse(Convert.ToString(value), out short level))
+                        level = 0;
+                    OverlayCPULevel = level;
+                    break;
+                }
             case "OnScreenDisplayRAMLevel":
-                OverlayRAMLevel = Convert.ToInt16(value);
-                break;
+                {
+                    if (!short.TryParse(Convert.ToString(value), out short level))
+                        level = 0;
+                    OverlayRAMLevel = level;
+                    break;
+                }
             case "OnScreenDisplayGPULevel":
-                OverlayGPULevel = Convert.ToInt16(value);
-                break;
+                {
+                    if (!short.TryParse(Convert.ToString(value), out short level))
+                        level = 0;
+                    OverlayGPULevel = level;
+                    break;
+                }
             case "OnScreenDisplayVRAMLevel":
-                OverlayVRAMLevel = Convert.ToInt16(value);
-                break;
+                {
+                    if (!short.TryParse(Convert.ToString(value), out short level))
+                        level = 0;
+                    OverlayVRAMLevel = level;
+                    break;
+                }
             case "OnScreenDisplayBATTLevel":
-                OverlayBATTLevel = Convert.ToInt16(value);
-                break;
+                {
+                    if (!short.TryParse(Convert.ToString(value), out short level))
+                        level = 0;
+                    OverlayBATTLevel = level;
+                    break;
+                }

Committable suggestion skipped: line range outside the PR's diff.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6655d98 and 2d96fe2.

📒 Files selected for processing (1)

• HandheldCompanion/Managers/Overlay/Widget/BatteryWidget.cs (1 hunks)

🧰 Additional context used

🧬 Code graph analysis (1)

HandheldCompanion/Managers/Overlay/Widget/BatteryWidget.cs (3)

HandheldCompanion/Managers/PlatformManager.cs (1)

• PlatformManager (11-119)

HandheldCompanion/Platforms/Misc/LibreHardware.cs (3)

• GetBatteryTimeSpan (399-399)
• GetBatteryLevel (397-397)
• GetBatteryPower (398-398)

HandheldCompanion/Managers/OSDManager.cs (7)

• OverlayEntry (384-408)
• OverlayEntry (388-394)
• OverlayEntry (396-399)
• OSDManager (12-336)
• OSDManager (45-49)
• AddElementIfNotNull (235-239)
• AddElementIfNotNull (241-245)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Build and Release

🔇 Additional comments (1)

HandheldCompanion/Managers/Overlay/Widget/BatteryWidget.cs (1)

42-53: LGTM! Charging detection correctly implemented.

The WMI query properly checks BatteryStatus values 6, 7, 8, and 9, which correspond to the documented charging states in the Win32_Battery class. The using statement ensures proper disposal of the searcher, and returning false when no battery is found is appropriate fallback behavior.

[coderabbitai]

⚠️ Potential issue | 🟠 Major

Cache TimeLeftInMinutes to avoid repeated hardware queries.

The TimeLeftInMinutes property invokes GetBatteryTimeSpan() on every access. Within a single Build() call, this property is read at line 33, then again inside TimeBatteryHours() (line 57), and once more in TimeBatteryMinutes() (line 65), resulting in three separate calls to the underlying hardware query.

Refactor to cache the value in a local variable:

 public void Build(OverlayEntry entry, short? level = null)
 {
     var _level = level ?? OSDManager.OverlayBATTLevel;
     if (_level == null)
     {
         return;
     }

     switch (_level)
     {
         case WidgetLevel.FULL:
             OSDManager.AddElementIfNotNull(entry, PlatformManager.LibreHardware.GetBatteryLevel(), "%");
             OSDManager.AddElementIfNotNull(entry, PlatformManager.LibreHardware.GetBatteryPower(), "W");
             break;
         case WidgetLevel.MINIMAL:
             OSDManager.AddElementIfNotNull(entry, PlatformManager.LibreHardware.GetBatteryLevel(), "%");
             break;
     }

     if (IsBatteryCharging())
     {
         return;
     }

-    if (!TimeLeftInMinutes.HasValue)
+    var timeLeft = TimeLeftInMinutes;
+    if (!timeLeft.HasValue)
     {
         return;
     }

-    OSDManager.AddElementIfNotNull(entry, TimeBatteryHours(), "h");
-    OSDManager.AddElementIfNotNull(entry, TimeBatteryMinutes(), "min");
+    OSDManager.AddElementIfNotNull(entry, TimeBatteryHours(timeLeft.Value), "h");
+    OSDManager.AddElementIfNotNull(entry, TimeBatteryMinutes(timeLeft.Value), "min");
 }

-private int TimeBatteryHours()
+private int TimeBatteryHours(float minutes)
 {
-    if (TimeLeftInMinutes is not float minutes)
-        return 0;
-
     return (int)(minutes / 60f);
 }

-private int TimeBatteryMinutes()
+private int TimeBatteryMinutes(float minutes)
 {
-    if (TimeLeftInMinutes is not float minutes)
-        return 0;
-
     return (int)(minutes % 60f);
 }

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	private float? TimeLeftInMinutes => PlatformManager.LibreHardware.GetBatteryTimeSpan();
	public void Build(OverlayEntry entry, short? level = null)
	{
	var _level = level ?? OSDManager.OverlayBATTLevel;
	if (_level == null)
	{
	return;
	}
	switch (_level)
	{
	case WidgetLevel.FULL:
	OSDManager.AddElementIfNotNull(entry, PlatformManager.LibreHardware.GetBatteryLevel(), "%");
	OSDManager.AddElementIfNotNull(entry, PlatformManager.LibreHardware.GetBatteryPower(), "W");
	break;
	case WidgetLevel.MINIMAL:
	OSDManager.AddElementIfNotNull(entry, PlatformManager.LibreHardware.GetBatteryLevel(), "%");
	break;
	}
	if (IsBatteryCharging())
	{
	return;
	}
	var timeLeft = TimeLeftInMinutes;
	if (!timeLeft.HasValue)
	{
	return;
	}
	OSDManager.AddElementIfNotNull(entry, TimeBatteryHours(timeLeft.Value), "h");
	OSDManager.AddElementIfNotNull(entry, TimeBatteryMinutes(timeLeft.Value), "min");
	}
	private int TimeBatteryHours(float minutes)
	{
	return (int)(minutes / 60f);
	}
	private int TimeBatteryMinutes(float minutes)
	{
	return (int)(minutes % 60f);
	}

🤖 Prompt for AI Agents

In HandheldCompanion/Managers/Overlay/Widget/BatteryWidget.cs around lines 7-8
(and usages at lines 33, 57, 65), the TimeLeftInMinutes property calls
PlatformManager.LibreHardware.GetBatteryTimeSpan() on every access causing three
hardware queries during a single Build(); refactor by calling
GetBatteryTimeSpan() once inside Build(), store the result in a local variable
(e.g., timeLeftInMinutes), and replace reads of the property within that Build()
invocation with the local variable; if necessary update TimeBatteryHours() and
TimeBatteryMinutes() to accept the nullable float as a parameter (or overload
them) so they use the cached value instead of re-querying the hardware.

[coderabbitai]

Actionable comments posted: 0

♻️ Duplicate comments (1)

HandheldCompanion/Managers/Overlay/Widget/BatteryWidget.cs (1)

8-9: Cache TimeLeftInMinutes to eliminate redundant hardware queries.

The TimeLeftInMinutes property triggers a hardware query via GetBatteryTimeSpan() on every access. Within a single Build() call, this property is accessed at line 29, line 40 (inside TimeBatteryHours()), and line 48 (inside TimeBatteryMinutes()), resulting in three separate hardware queries.

Refactor to cache the value in a local variable and pass it to the helper methods:

 public void Build(OverlayEntry entry, short? level = null)
 {
     short _level = level ?? OSDManager.OverlayBATTLevel;
     switch (_level)
     {
         case WidgetLevel.FULL:
             OSDManager.AddElementIfNotNull(entry, PlatformManager.LibreHardware.GetBatteryLevel(), "%");
             OSDManager.AddElementIfNotNull(entry, PlatformManager.LibreHardware.GetBatteryPower(), "W");
             break;
         case WidgetLevel.MINIMAL:
             OSDManager.AddElementIfNotNull(entry, PlatformManager.LibreHardware.GetBatteryLevel(), "%");
             break;
         default:
             return;
     }

     if (IsBatteryCharging())
         return;

-    if (!TimeLeftInMinutes.HasValue)
+    var timeLeft = TimeLeftInMinutes;
+    if (!timeLeft.HasValue)
         return;

-    OSDManager.AddElementIfNotNull(entry, TimeBatteryHours(), "h");
-    OSDManager.AddElementIfNotNull(entry, TimeBatteryMinutes(), "min");
+    OSDManager.AddElementIfNotNull(entry, TimeBatteryHours(timeLeft.Value), "h");
+    OSDManager.AddElementIfNotNull(entry, TimeBatteryMinutes(timeLeft.Value), "min");
 }

-private int TimeBatteryHours()
+private int TimeBatteryHours(float minutes)
 {
-    if (TimeLeftInMinutes is not float minutes)
-        return 0;
-
     return (int)(minutes / 60f);
 }

-private int TimeBatteryMinutes()
+private int TimeBatteryMinutes(float minutes)
 {
-    if (TimeLeftInMinutes is not float minutes)
-        return 0;
-
     return (int)(minutes % 60f);
 }

🧹 Nitpick comments (2)

HandheldCompanion/Managers/Overlay/Widget/BatteryWidget.cs (2)

1-1: Remove unused import.

System.Management is no longer used after the charging detection was refactored to use SystemInformation.PowerStatus instead of WMI queries.

Apply this diff to remove the unused import:

-using System.Management;
 using System.Windows.Forms;

---

36-36: Method name doesn't match its behavior.

IsBatteryCharging() checks PowerLineStatus.Online, which indicates the device is plugged into AC power, not whether the battery is actively charging. When the battery is full and plugged in, this returns true even though the battery isn't charging. Consider renaming to IsPluggedIn() or IsOnACPower() for clarity.

Apply this diff to clarify the method name:

-private static bool IsBatteryCharging() => SystemInformation.PowerStatus.PowerLineStatus == PowerLineStatus.Online;
+private static bool IsPluggedIn() => SystemInformation.PowerStatus.PowerLineStatus == PowerLineStatus.Online;

And update the call site:

-if (IsBatteryCharging())
+if (IsPluggedIn())
     return;

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2d96fe2 and c79566f.

📒 Files selected for processing (1)

• HandheldCompanion/Managers/Overlay/Widget/BatteryWidget.cs (1 hunks)

🧰 Additional context used

🧬 Code graph analysis (1)

HandheldCompanion/Managers/Overlay/Widget/BatteryWidget.cs (3)

HandheldCompanion/Managers/PlatformManager.cs (1)

• PlatformManager (11-119)

HandheldCompanion/Platforms/Misc/LibreHardware.cs (3)

• GetBatteryTimeSpan (399-399)
• GetBatteryLevel (397-397)
• GetBatteryPower (398-398)

HandheldCompanion/Managers/OSDManager.cs (7)

• OverlayEntry (384-408)
• OverlayEntry (388-394)
• OverlayEntry (396-399)
• OSDManager (12-336)
• OSDManager (45-49)
• AddElementIfNotNull (235-239)
• AddElementIfNotNull (241-245)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Build and Release

🔇 Additional comments (3)

HandheldCompanion/Managers/Overlay/Widget/BatteryWidget.cs (3)

22-23: Good defensive practice.

Adding a default case prevents unknown widget level values from falling through to the battery time display logic.

---

26-30: LGTM!

The early returns correctly handle the cases where battery time shouldn't be displayed: when the device is plugged in and when time data is unavailable.

---

38-52: LGTM!

The hour and minute calculations are correct. The null checks using pattern matching are technically redundant given the guard at line 29, but they make these methods more defensive and reusable.

[Valkirie]

Thanks! Merged in EA as well.