New power calculation methods

Replacing old power calculation methods with new system. On connection, WinNUT determines what power/load data variables are available and sets an enum variable accordingly. If no such method is available, a warning is logged to the output, and future attempts to get the power value will return with 0. On every update, the appropriate method is selected from the enum variable and the calculation is returned. The hope is that this covers the majority of UPS devices.
- Also cleaned up or rearranged code in the UPS_Device class.

Author: gbakeman

WinNUT_V2/WinNUT-Client_Common/Common_Enums.vb

@@ -116,3 +116,10 @@ Public Enum UPS_States
     TRIM = 1 << 11
     BOOST = 1 << 12
 End Enum
+
+Public Enum PowerMethod
+    Unavailable ' No methods are available to calculate power.
+    RealPower ' The ups.realpower variable is available for direct reading.
+    NominalPowerCalc ' Power can be calculated by taking the load percentage of the nominal power variable.
+    VoltAmpCalc ' Power will have be calculated as a function of volts and amps.
+End Enum

WinNUT_V2/WinNUT-Client_Common/UPS_Device.vb

@@ -64,11 +64,11 @@ Public Class UPS_Device
         End Set
     End Property
 
-    Private _MaxLoad As Integer
+    Private _PowerCalculationMethod As PowerMethod
 
-    Public ReadOnly Property MaxLoad As Integer
+    Public ReadOnly Property PowerCalculationMethod As PowerMethod
         Get
-            Return _MaxLoad
+            Return _PowerCalculationMethod
         End Get
     End Property
 
@@ -107,25 +107,14 @@ Public Class UPS_Device
     Private Const DEFAULT_RECONNECT_WAIT_MS As Double = 5000
 
     Private WithEvents Update_Data As New Timer
-    'Private Nut_Conn As Nut_Comm
-    ' Private LogFile As Logger
+    Private WithEvents Reconnect_Nut As New Timer
+    Private WithEvents Nut_Socket As Nut_Socket
+
     Private Freq_Fallback As Double
     Private ciClone As CultureInfo
-
     Public Nut_Config As Nut_Parameter
-
-    ' Public UPSData As New UPSData
-
-
-    Private WithEvents Nut_Socket As Nut_Socket
-
     Public Retry As Integer = 0
     Public MaxRetry As Integer = 30
-    Private WithEvents Reconnect_Nut As New System.Windows.Forms.Timer
-
-
-
-
     Private LogFile As Logger
 
     Public Sub New(ByRef Nut_Config As Nut_Parameter, ByRef LogFile As Logger, pollInterval As Integer)
@@ -233,24 +222,44 @@ Public Class UPS_Device
             Trim(GetUPSVar("ups.serial", "Unknown")),
             Trim(GetUPSVar("ups.firmware", "Unknown")))
 
+        ' Determine available power & load data
+        Try
+            GetUPSVar("ups.realpower")
+            _PowerCalculationMethod = PowerMethod.RealPower
+            LogFile.LogTracing("Using RealPower method to calculate power usage.", LogLvl.LOG_NOTICE, Me)
+        Catch
+            Try
+                GetUPSVar("ups.realpower.nominal")
+                GetUPSVar("ups.load")
+                _PowerCalculationMethod = PowerMethod.NominalPowerCalc
+                LogFile.LogTracing("Using NominalPowerCalc method to calculate power usage.", LogLvl.LOG_NOTICE, Me)
+            Catch
+                Try
+                    GetUPSVar("input.current.nominal")
+                    GetUPSVar("input.voltage.nominal")
+                    GetUPSVar("ups.load")
+                    _PowerCalculationMethod = PowerMethod.VoltAmpCalc
+                    LogFile.LogTracing("Using VoltAmpCalc method to calculate power usage.", LogLvl.LOG_NOTICE, Me)
+                Catch
+                    _PowerCalculationMethod = PowerMethod.Unavailable
+                    LogFile.LogTracing("Unable to find a suitable method to calculate power usage.", LogLvl.LOG_WARNING, Me)
+                End Try
+            End Try
+        End Try
+
         ' Other constant values for UPS calibration.
         freshData.UPS_Value.Batt_Capacity = Double.Parse(GetUPSVar("battery.capacity", 7), ciClone)
         Freq_Fallback = Double.Parse(GetUPSVar("output.frequency.nominal", (50 + CInt(Arr_Reg_Key.Item("FrequencySupply")) * 10)), ciClone)
 
         Return freshData
     End Function
 
-    Private Function FindMaxLoad() As Integer
-
-    End Function
-
     Private oldStatusBitmask As Integer
 
     Public Sub Retrieve_UPS_Datas() Handles Update_Data.Tick ' As UPSData
         LogFile.LogTracing("Enter Retrieve_UPS_Datas", LogLvl.LOG_DEBUG, Me)
         Try
             Dim UPS_rt_Status As String
-            Dim InputA As Double
 
             If IsConnected Then
                 With UPS_Datas.UPS_Value
@@ -260,20 +269,9 @@ Public Class UPS_Device
                     .Power_Frequency = Double.Parse(GetUPSVar("input.frequency", Double.Parse(GetUPSVar("output.frequency", Freq_Fallback), ciClone)), ciClone)
                     .Input_Voltage = Double.Parse(GetUPSVar("input.voltage", 220), ciClone)
                     .Output_Voltage = Double.Parse(GetUPSVar("output.voltage", .Input_Voltage), ciClone)
-                    .Load = Double.Parse(GetUPSVar("ups.load", 100), ciClone)
-                    UPS_rt_Status = GetUPSVar("ups.status", UPS_States.None)
-                    .Output_Power = Double.Parse((GetUPSVar("ups.realpower.nominal", 0)), ciClone)
-                    If .Output_Power = 0 Then
-                        .Output_Power = Double.Parse((GetUPSVar("ups.power.nominal", 0)), ciClone)
-                        If .Output_Power = 0 Then
-                            InputA = Double.Parse(GetUPSVar("ups.current.nominal", 1), ciClone)
-                            .Output_Power = Math.Round(.Input_Voltage * 0.95 * InputA * CosPhi)
-                        Else
-                            .Output_Power = Math.Round(.Output_Power * (.Load / 100) * CosPhi)
-                        End If
-                    Else
-                        .Output_Power = Math.Round(.Output_Power * (.Load / 100))
-                    End If
+                    .Load = Double.Parse(GetUPSVar("ups.load", 0), ciClone)
+                    .Output_Power = If(_PowerCalculationMethod <> PowerMethod.Unavailable, GetPowerUsage(), 0)
+
                     Dim PowerDivider As Double = 0.5
                     Select Case .Load
                         Case 76 To 100
@@ -294,6 +292,7 @@ Public Class UPS_Device
                         .Batt_Runtime = Math.Floor(.Batt_Capacity * 0.6 * .Batt_Charge * (1 - PowerDivider) * 3600 / (BattInstantCurrent * 100))
                     End If
 
+                    UPS_rt_Status = GetUPSVar("ups.status", UPS_States.None)
                     ' Prepare the status string for Enum parsing by replacing spaces with commas.
                     UPS_rt_Status = UPS_rt_Status.Replace(" ", ",")
                     Try
@@ -325,6 +324,27 @@ Public Class UPS_Device
         End Try
     End Sub
 
+    ''' <summary>
+    ''' Attempts to get the power usage of this UPS.
+    ''' </summary>
+    ''' <returns></returns>
+    ''' <throws><see cref="NutException"/></throws>
+    Private Function GetPowerUsage() As Double
+        If _PowerCalculationMethod = PowerMethod.RealPower Then
+            Return Integer.Parse(GetUPSVar("ups.realpower"))
+        ElseIf _PowerCalculationMethod = PowerMethod.NominalPowerCalc Then
+            Return Integer.Parse(GetUPSVar("ups.realpower.nominal")) *
+                (UPS_Datas.UPS_Value.Load / 100.0)
+        ElseIf _PowerCalculationMethod = PowerMethod.VoltAmpCalc Then
+            Dim nomCurrent = Double.Parse(GetUPSVar("input.current.nominal"))
+            Dim nomVoltage = Double.Parse(GetUPSVar("input.voltage.nominal"))
+
+            Return (nomCurrent * nomVoltage * 0.8) * (UPS_Datas.UPS_Value.Load / 100.0)
+        Else
+            Throw New InvalidOperationException("Insufficient variables to calculate power.")
+        End If
+    End Function
+
     Private Const MAX_VAR_RETRIES = 3
     Public Function GetUPSVar(varName As String, Optional Fallback_value As Object = Nothing, Optional recursing As Boolean = False) As String
         If Not IsConnected Then