Better handling of missing variables

gbakeman · gbakeman · commit 4dfc2919b2a5 · 2024-02-18T17:12:16.000-05:00
- Battery and voltage properties are now set to an invalid value (-1) when they are unavailable, rather than the previous method of setting them to a "fallback" value. Partially addresses #116 - Attempt to calculate battery charge fails and leaves a log message if the battery voltage is unavailable. - Attempt to calculate battery runtime fails if other consequential values are unavailable. This may be problematic for calculations that rely on a "good enough" default value. However, I currently don't see any scenario where that would be acceptable to someone relying on an accurate calculation. - When UPS status is on battery, log an error if battery variables are unavailable when trying to determine if a stop action is needed. Will need to follow this up and warn the user that stop actions are unavailable if battery info isn't present. - When battery runtime is unavailable to WinNUT, display localized message instead.
diff --git a/WinNUT_V2/WinNUT-Client/My Project/Resources.Designer.vb b/WinNUT_V2/WinNUT-Client/My Project/Resources.Designer.vb
diff --git a/WinNUT_V2/WinNUT-Client/My Project/Resources.resx b/WinNUT_V2/WinNUT-Client/My Project/Resources.resx
@@ -367,6 +367,10 @@ Please correct the error, or cancel the upgrade dialog to continue with the defa
   <data name="ups_104x104" type="System.Resources.ResXFileRef, System.Windows.Forms">
     <value>..\Resources\ups_104x104.png;System.Drawing.Bitmap, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a</value>
   </data>
+  <data name="VariableUnavailable" xml:space="preserve">
+    <value>Unavailable</value>
+    <comment>Indicate that a variable is unavailable</comment>
+  </data>
   <data name="ViewLogFile_24x24" type="System.Resources.ResXFileRef, System.Windows.Forms">
     <value>..\Resources\ViewLogFile_24x24.png;System.Drawing.Bitmap, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a</value>
   </data>
diff --git a/WinNUT_V2/WinNUT-Client/WinNUT.vb b/WinNUT_V2/WinNUT-Client/WinNUT.vb
@@ -686,21 +686,23 @@ Public Class WinNUT
                 Lbl_VOB.BackColor = Color.Green
                 ActualAppIconIdx = 0
 
-                If Not ShutdownStatus Then
-                    If .Batt_Charge <= My.Settings.PW_BattChrgFloor Or
-                    .Batt_Runtime <= My.Settings.PW_RuntimeFloor Then
-                        LogFile.LogTracing("UPS battery has dropped below stop condition limits.",
-                                           LogLvl.LOG_NOTICE, Me, StrLog.Item(AppResxStr.STR_LOG_SHUT_START))
-                        Shutdown_Event()
-                    Else
-                        LogFile.LogTracing(String.Format("UPS charge ({0}%) or Runtime ({1}) have not met shutdown conditions {2} or {3}.",
-                        .Batt_Charge, .Batt_Runtime, My.Settings.PW_BattChrgFloor, My.Settings.PW_RuntimeFloor),
-                        LogLvl.LOG_DEBUG, Me)
+                If .Batt_Charge = -1 AndAlso .Batt_Runtime = -1 Then
+                    LogFile.LogTracing("Battery properties unavailable, unable to validate shutdown conditions.", LogLvl.LOG_WARNING, Me)
+                ElseIf Not ShutdownStatus Then
+                If .Batt_Charge <= My.Settings.PW_BattChrgFloor Or
+                        .Batt_Runtime <= My.Settings.PW_RuntimeFloor Then
+                            LogFile.LogTracing("UPS battery has dropped below stop condition limits.",
+                                               LogLvl.LOG_NOTICE, Me, StrLog.Item(AppResxStr.STR_LOG_SHUT_START))
+                            Shutdown_Event()
+                        Else
+                            LogFile.LogTracing(String.Format("UPS charge ({0}%) or Runtime ({1}) have not met shutdown conditions {2} or {3}.",
+                            .Batt_Charge, .Batt_Runtime, My.Settings.PW_BattChrgFloor, My.Settings.PW_RuntimeFloor),
+                            LogLvl.LOG_DEBUG, Me)
+                        End If
                     End If
                 End If
-            End If
 
-            If .UPS_Status.HasFlag(UPS_States.OVER) Then
+                If .UPS_Status.HasFlag(UPS_States.OVER) Then
                 Lbl_VOLoad.BackColor = Color.Red
             Else
                 Lbl_VOLoad.BackColor = Color.White
@@ -730,17 +732,20 @@ Public Class WinNUT
             End Select
 
             ' Calculate and display estimated remaining time on battery.
-            ' TODO: overflow exception?
-            Dim iSpan As TimeSpan = TimeSpan.FromSeconds(UPS_BattRuntime)
-            LogFile.LogTracing("Calculated estimated remaining battery time: " & iSpan.ToString(), LogLvl.LOG_DEBUG, Me)
-
-            ' Format the TimeSpan using a standard format (g = 0:00:00)
-            ' https://docs.microsoft.com/en-us/dotnet/api/system.timespan.tostring
-            Lbl_VRTime.Text = iSpan.ToString("g")
-            'Lbl_VRTime.Text = iSpan.Hours.ToString.PadLeft(2, "0"c) & ":" &
-            'iSpan.Minutes.ToString.PadLeft(2, "0"c) & ":" &
-            'iSpan.Seconds.ToString.PadLeft(2, "0"c)
-            'End If
+            If UPS_BattRuntime >= 0 AndAlso UPS_BattRuntime <= 86400 Then
+                Dim iSpan As TimeSpan = TimeSpan.FromSeconds(UPS_BattRuntime)
+                LogFile.LogTracing("Calculated estimated remaining battery time: " & iSpan.ToString(), LogLvl.LOG_DEBUG, Me)
+
+                ' Format the TimeSpan using a standard format (g = 0:00:00)
+                ' https://docs.microsoft.com/en-us/dotnet/api/system.timespan.tostring
+                Lbl_VRTime.Text = iSpan.ToString("g")
+                'Lbl_VRTime.Text = iSpan.Hours.ToString.PadLeft(2, "0"c) & ":" &
+                'iSpan.Minutes.ToString.PadLeft(2, "0"c) & ":" &
+                'iSpan.Seconds.ToString.PadLeft(2, "0"c)
+                'End If
+            Else
+                Lbl_VRTime.Text = My.Resources.VariableUnavailable
+            End If
 
             LogFile.LogTracing("Update Dial", LogLvl.LOG_DEBUG, Me)
             AG_InV.Value1 = UPS_InputV
diff --git a/WinNUT_V2/WinNUT-Client_Common/UPS_Device.vb b/WinNUT_V2/WinNUT-Client_Common/UPS_Device.vb
@@ -264,7 +264,7 @@ Public Class UPS_Device
         End Try
 
         ' Other constant values for UPS calibration.
-        freshData.UPS_Value.Batt_Capacity = Double.Parse(GetUPSVar("battery.capacity", 7), INVARIANT_CULTURE)
+        freshData.UPS_Value.Batt_Capacity = Double.Parse(GetUPSVar("battery.capacity", -1), INVARIANT_CULTURE)
         Freq_Fallback = Double.Parse(GetUPSVar("output.frequency.nominal", Freq_Fallback), INVARIANT_CULTURE)
 
         LogFile.LogTracing("Completed retrieval of basic UPS product information.", LogLvl.LOG_NOTICE, Me)
@@ -280,11 +280,11 @@ Public Class UPS_Device
 
             If IsConnected Then
                 With UPS_Datas.UPS_Value
-                    .Batt_Charge = Double.Parse(GetUPSVar("battery.charge", 255), INVARIANT_CULTURE)
-                    .Batt_Voltage = Double.Parse(GetUPSVar("battery.voltage", 12), INVARIANT_CULTURE)
-                    .Batt_Runtime = Double.Parse(GetUPSVar("battery.runtime", 86400), INVARIANT_CULTURE)
+                    .Batt_Charge = Double.Parse(GetUPSVar("battery.charge", -1), INVARIANT_CULTURE)
+                    .Batt_Voltage = Double.Parse(GetUPSVar("battery.voltage", -1), INVARIANT_CULTURE)
+                    .Batt_Runtime = Double.Parse(GetUPSVar("battery.runtime", -1), INVARIANT_CULTURE)
                     .Power_Frequency = Double.Parse(GetUPSVar("input.frequency", Double.Parse(GetUPSVar("output.frequency", Freq_Fallback), INVARIANT_CULTURE)), INVARIANT_CULTURE)
-                    .Input_Voltage = Double.Parse(GetUPSVar("input.voltage", 220), INVARIANT_CULTURE)
+                    .Input_Voltage = Double.Parse(GetUPSVar("input.voltage", -1), INVARIANT_CULTURE)
                     .Output_Voltage = Double.Parse(GetUPSVar("output.voltage", .Input_Voltage), INVARIANT_CULTURE)
                     .Load = Double.Parse(GetUPSVar("ups.load", 0), INVARIANT_CULTURE)
 
@@ -317,24 +317,36 @@ Public Class UPS_Device
                         .Output_Power = parsedValue
                     End If
 
-                    ' Handle cases of UPSs that are unable to report battery runtime or load correctly while on battery.
-                    Dim PowerDivider As Double = 0.5
-                    Select Case .Load
-                        Case 76 To 100
-                            PowerDivider = 0.4
-                        Case 51 To 75
-                            PowerDivider = 0.3
-                    End Select
-
-                    If .Batt_Charge = 255 Then
-                        Dim nBatt = Math.Floor(.Batt_Voltage / 12)
-                        .Batt_Charge = Math.Floor((.Batt_Voltage - (11.6 * nBatt)) / (0.02 * nBatt))
+                    ' Handle out-of-range battery charge
+                    If .Batt_Charge > 0 AndAlso .Batt_Charge <= 100 Then
+                        If .Batt_Voltage > 0 Then
+                            Dim nBatt = Math.Floor(.Batt_Voltage / 12)
+                            .Batt_Charge = Math.Floor((.Batt_Voltage - (11.6 * nBatt)) / (0.02 * nBatt))
+                        Else
+                            LogFile.LogTracing("Unable to calculate UPS Batt_Charge: Batt_Voltage (" & .Batt_Voltage & ") out of range.", LogLvl.LOG_WARNING, Me)
+                        End If
                     End If
 
-                    If .Batt_Runtime >= 86400 Then
-                        .Load = If(.Load <> 0, .Load, 0.1)
-                        Dim BattInstantCurrent = (.Output_Voltage * .Load) / (.Batt_Voltage * 100)
-                        .Batt_Runtime = Math.Floor(.Batt_Capacity * 0.6 * .Batt_Charge * (1 - PowerDivider) * 3600 / (BattInstantCurrent * 100))
+                    ' Handle cases of UPSs that are unable to report battery runtime or load correctly while on battery.
+                    If .Batt_Runtime = -1 Then
+                        If .Output_Voltage = -1 OrElse .Batt_Voltage = -1 OrElse .Batt_Capacity = -1 OrElse .Batt_Charge = -1 Then
+                            LogFile.LogTracing("Unable to calculate battery runtime, missing UPS variables.", LogLvl.LOG_WARNING, Me)
+                            LogFile.LogTracing(String.Format("Output_Voltage: {0}, Batt_Voltage: {1}, Batt_Capacity: {2}, Batt_Charge: {3}",
+                                .Output_Voltage, .Batt_Voltage, .Batt_Capacity, .Batt_Charge), LogLvl.LOG_WARNING, Me)
+
+                        Else
+                            Dim PowerDivider As Double = 0.5
+                            Select Case .Load
+                                Case 76 To 100
+                                    PowerDivider = 0.4
+                                Case 51 To 75
+                                    PowerDivider = 0.3
+                            End Select
+
+                            .Load = If(.Load <> 0, .Load, 0.1)
+                            Dim BattInstantCurrent = (.Output_Voltage * .Load) / (.Batt_Voltage * 100)
+                            .Batt_Runtime = Math.Floor(.Batt_Capacity * 0.6 * .Batt_Charge * (1 - PowerDivider) * 3600 / (BattInstantCurrent * 100))
+                        End If
                     End If
 
                     UPS_rt_Status = GetUPSVar("ups.status", UPS_States.None)
