UPS Status update changes, reactivate stop system

- Removed Shutdown_Condition and Stop_Shutdown events in favor of one StatusesChanged event
- Rewrote the status updating portion of Retrieve_UPS_Datas to try and make it more efficient, and allow the client to handle changes in status.
- Moved handling of status changes into WinNUT.vb, and reactivated disabled stop system.

Author: gbakeman

WinNUT_V2/WinNUT-Client/WinNUT.vb

@@ -37,11 +37,6 @@ Public Class WinNUT
 
     'Object for UPS management
     Public WithEvents UPS_Device As UPS_Device
-    ' Public Nut_Socket As Nut_Socket
-    ' Public Nut_Config As New Nut_Parameter
-    ' Private Device_Data As UPSData
-
-    ' ^--- Shall be referenced from inside UPS_Device object
 
     Private AutoReconnect As Boolean
     Private UPS_Retry As Integer = 0
@@ -665,16 +660,16 @@ Public Class WinNUT
             UPS_Status = "OL"
             UPS_OutPower = .Output_Power
 
-            If (.UPS_Status And UPS_States.OL) Then
+            If .UPS_Status.HasFlag(UPS_States.OL) Then
                 Lbl_VOL.BackColor = Color.Green
                 Lbl_VOB.BackColor = Color.White
                 ActualAppIconIdx = AppIconIdx.IDX_OL
-            ElseIf (.UPS_Status And UPS_States.OB) Then
+            ElseIf .UPS_Status.HasFlag(UPS_States.OB) Then
                 Lbl_VOL.BackColor = Color.Yellow
                 Lbl_VOB.BackColor = Color.Green
                 ActualAppIconIdx = 0
             End If
-            If (.UPS_Status And UPS_States.OVER) Then
+            If .UPS_Status.HasFlag(UPS_States.OVER) Then
                 Lbl_VOLoad.BackColor = Color.Red
             Else
                 Lbl_VOLoad.BackColor = Color.White
@@ -699,31 +694,27 @@ Public Class WinNUT
             '        Lbl_VOLoad.BackColor = Color.White
             '    End If
 
+            LogFile.LogTracing("Updating battery icons based on charge percent: " & UPS_BattCh & "%", LogLvl.LOG_DEBUG, Me)
+
             Select Case UPS_BattCh
                 Case 76 To 100
                     Lbl_VBL.BackColor = Color.White
                     ActualAppIconIdx = ActualAppIconIdx Or AppIconIdx.IDX_BATT_100
-                    LogFile.LogTracing("Battery Charged", LogLvl.LOG_DEBUG, Me)
                 Case 51 To 75
                     Lbl_VBL.BackColor = Color.White
                     ActualAppIconIdx = ActualAppIconIdx Or AppIconIdx.IDX_BATT_75
-                    LogFile.LogTracing("Battery Charged", LogLvl.LOG_DEBUG, Me)
                 Case 40 To 50
                     Lbl_VBL.BackColor = Color.White
                     ActualAppIconIdx = ActualAppIconIdx Or AppIconIdx.IDX_BATT_50
-                    LogFile.LogTracing("Battery Charged", LogLvl.LOG_DEBUG, Me)
                 Case 26 To 39
                     Lbl_VBL.BackColor = Color.Red
                     ActualAppIconIdx = ActualAppIconIdx Or AppIconIdx.IDX_BATT_50
-                    LogFile.LogTracing("Low Battery", LogLvl.LOG_DEBUG, Me)
                 Case 11 To 25
                     Lbl_VBL.BackColor = Color.Red
                     ActualAppIconIdx = ActualAppIconIdx Or AppIconIdx.IDX_BATT_25
-                    LogFile.LogTracing("Low Battery", LogLvl.LOG_DEBUG, Me)
                 Case 0 To 10
                     Lbl_VBL.BackColor = Color.Red
                     ActualAppIconIdx = ActualAppIconIdx Or AppIconIdx.IDX_BATT_0
-                    LogFile.LogTracing("Low Battery", LogLvl.LOG_DEBUG, Me)
             End Select
 
             ' Calculate and display estimated remaining time on battery.
@@ -1041,9 +1032,44 @@ Public Class WinNUT
         End If
     End Sub
 
-    Private Sub Shutdown_Event() Handles UPS_Device.Shutdown_Condition
+    Private Sub HandleUPSStatusChange(sender As UPS_Device, newStatuses As UPS_States) Handles UPS_Device.StatusesChanged
+        LogFile.LogTracing("Handling new UPS status(es)...", LogLvl.LOG_DEBUG, Me)
+        Dim statusString As String = ""
+
+        With sender.UPS_Datas.UPS_Value
+            For Each status In [Enum].GetValues(GetType(UPS_States))
+                If newStatuses.HasFlag(status) Then
+                    statusString &= [Enum].GetName(GetType(UPS_States), status) & " "
+                    ' Determine if we need to initiate the stop procedure.
+                    If status = UPS_States.FSD Then
+                        LogFile.LogTracing("Full Shut Down imposed by the NUT server.", LogLvl.LOG_NOTICE, Me, StrLog.Item(AppResxStr.STR_LOG_NUT_FSD))
+                        Shutdown_Event()
+                    ElseIf status = UPS_States.OB And
+                            (.Batt_Charge <= Arr_Reg_Key.Item("ShutdownLimitBatteryCharge") Or
+                            .Batt_Runtime <= Arr_Reg_Key.Item("ShutdownLimitUPSRemainTime")) And
+                            Not ShutdownStatus Then
+                        LogFile.LogTracing("UPS battery has dropped below stop condition limits.", LogLvl.LOG_NOTICE, Me, WinNUT_Globals.StrLog.Item(AppResxStr.STR_LOG_SHUT_START))
+                        Shutdown_Event()
+                    ElseIf status = UPS_States.OL AndAlso ShutdownStatus Then
+                        LogFile.LogTracing("UPS returned online during a pre-shutdown event.", LogLvl.LOG_NOTICE, Me)
+                        Stop_Shutdown_Event()
+                    End If
+                End If
+            Next
+        End With
+
+        LogFile.LogTracing("Finished handling new UPS statuses: " & statusString, LogLvl.LOG_NOTICE, Me)
+    End Sub
+
+    ''' <summary>
+    ''' Track if the Shutdown_Gui is counting down to activate the Shutdown_Action.
+    ''' </summary>
+    Private ShutdownStatus = False
+    Private Sub Shutdown_Event()
+        ShutdownStatus = True
+
         If Arr_Reg_Key.Item("ImmediateStopAction") Then
-            ' UPSDisconnect()
+            LogFile.LogTracing("Immediately stopping due to shutdown event.", LogLvl.LOG_NOTICE, Me)
             UPS_Device.Disconnect()
             Shutdown_Action()
         Else
@@ -1054,13 +1080,15 @@ Public Class WinNUT
         End If
     End Sub
 
-    Private Sub Stop_Shutdown_Event() Handles UPS_Device.Stop_Shutdown
+    Private Sub Stop_Shutdown_Event()
+        ShutdownStatus = False
         Shutdown_Gui.Shutdown_Timer.Stop()
         Shutdown_Gui.Shutdown_Timer.Enabled = False
         Shutdown_Gui.Grace_Timer.Stop()
         Shutdown_Gui.Grace_Timer.Enabled = False
         Shutdown_Gui.Hide()
         Shutdown_Gui.Close()
+        LogFile.LogTracing("Stop condition cancelled.", LogLvl.LOG_NOTICE, Me, WinNUT_Globals.StrLog.Item(AppResxStr.STR_LOG_SHUT_STOP))
     End Sub
 
     Public Sub Shutdown_Action()

WinNUT_V2/WinNUT-Client_Common/UPS_Device.vb

@@ -13,6 +13,12 @@ Imports System.Windows.Forms
 Public Class UPS_Device
 #Region "Properties"
 
+    Public ReadOnly Property Name As String
+        Get
+            Return Nut_Config.UPSName
+        End Get
+    End Property
+
     Public ReadOnly Property IsConnected As Boolean
         Get
             Return (Nut_Socket.IsConnected) ' And Me.Socket_Status
@@ -34,6 +40,16 @@ Public Class UPS_Device
         End Set
     End Property
 
+    Private upsData As UPSData
+    Public Property UPS_Datas As UPSData
+        Get
+            Return upsData
+        End Get
+        Private Set(value As UPSData)
+            upsData = value
+        End Set
+    End Property
+
 #End Region
     Private Const CosPhi As Double = 0.6
     ' How many milliseconds to wait before the Reconnect routine tries again.
@@ -103,28 +119,13 @@ Public Class UPS_Device
     'Private NutStream As System.Net.Sockets.NetworkStream
     'Private ReaderStream As System.IO.StreamReader
     'Private WriterStream As System.IO.StreamWriter
-    'Private ShutdownStatus As Boolean = False
     'Private Follow_FSD As Boolean = False
     'Private Unknown_UPS_Name As Boolean = False
     'Private Invalid_Data As Boolean = False
     'Private Invalid_Auth_Data As Boolean = False
 
 #Region "Properties"
-    Private upsData As UPSData
-    Public Property UPS_Datas As UPSData
-        Get
-            Return upsData
-        End Get
-        Private Set(value As UPSData)
-            upsData = value
-        End Set
-    End Property
 
-    Public ReadOnly Property Name As String
-        Get
-            Return Nut_Config.UPSName
-        End Get
-    End Property
 #End Region
 
     ' Public Event Unknown_UPS()
@@ -139,8 +140,14 @@ Public Class UPS_Device
     Public Event ConnectionError(innerException As Exception)
     Public Event EncounteredNUTException(ex As NutException, sender As Object)
     Public Event New_Retry()
-    Public Event Shutdown_Condition()
-    Public Event Stop_Shutdown()
+    ' Public Event Shutdown_Condition()
+    ' Public Event Stop_Shutdown()
+
+    ''' <summary>
+    ''' Raise an event when a status code is added to the UPS that wasn't there before.
+    ''' </summary>
+    ''' <param name="newStatuses">The bitmask of status flags that are currently set on the UPS.</param>
+    Public Event StatusesChanged(sender As UPS_Device, newStatuses As UPS_States)
 
     Public Sub New(ByRef Nut_Config As Nut_Parameter, ByRef LogFile As Logger, pollInterval As Integer)
         Me.LogFile = LogFile
@@ -291,6 +298,8 @@ Public Class UPS_Device
         Return freshData
     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
@@ -304,6 +313,7 @@ Public Class UPS_Device
                 '            UPS_Datas = GetUPSProductInfo()
                 '    End Select
                 'End With
+
                 With UPS_Datas.UPS_Value
                     .Batt_Charge = Double.Parse(GetUPSVar("battery.charge", 255), ciClone)
                     .Batt_Voltage = Double.Parse(GetUPSVar("battery.voltage", 12), ciClone)
@@ -312,7 +322,7 @@ Public Class UPS_Device
                     .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", "OL")
+                    UPS_rt_Status = GetUPSVar("ups.status")
                     .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)
@@ -344,70 +354,26 @@ Public Class UPS_Device
                         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
-                    Dim StatusArr = UPS_rt_Status.Trim().Split(" ")
-                    .UPS_Status = 0
-                    For Each State In StatusArr
-                        Select Case State
-                            Case "OL"
-                                LogFile.LogTracing("UPS is On Line", LogLvl.LOG_NOTICE, Me)
-                                .UPS_Status = .UPS_Status Or UPS_States.OL
-                            'If Not Update_Nut.Interval = Me.Delay Then
-                            '    Update_Nut.Stop()
-                            '    Update_Nut.Interval = Me.Delay
-                            '    Update_Nut.Start()
-                            'End If
-                            'If ShutdownStatus Then
-                            '    LogFile.LogTracing("Stop condition Canceled", LogLvl.LOG_NOTICE, Me, WinNUT_Globals.StrLog.Item(AppResxStr.STR_LOG_SHUT_STOP))
-                            '    ShutdownStatus = False
-                            '    RaiseEvent Stop_Shutdown()
-                            'End If
-                            Case "OB"
-                                LogFile.LogTracing("UPS is On Battery", LogLvl.LOG_NOTICE, Me)
-                                .UPS_Status = .UPS_Status Or UPS_States.OB
-                            'If Update_Nut.Interval = Me.Delay Then
-                            '    Update_Nut.Stop()
-                            '    Update_Nut.Interval = If((Math.Floor(Me.Delay / 5) < 1000), 1000, Math.Floor(Me.Delay / 5))
-                            '    Update_Nut.Start()
-                            'End If
-                            'If ((Me.BattCh <= Me.Low_Batt Or Me.BattRuntime <= Me.Backup_Limit) And Not ShutdownStatus) Then
-                            '    LogFile.LogTracing("Stop condition reached", LogLvl.LOG_NOTICE, Me, WinNUT_Globals.StrLog.Item(AppResxStr.STR_LOG_SHUT_START))
-                            '    RaiseEvent Shutdown_Condition()
-                            '    ShutdownStatus = True
-                            'End If
-                            Case "LB", "HB"
-                                LogFile.LogTracing("High/Low Battery on UPS", LogLvl.LOG_NOTICE, Me)
-                                .UPS_Status = .UPS_Status Or UPS_States.LBHB
-                            Case "CHRG"
-                                LogFile.LogTracing("Battery is Charging on UPS", LogLvl.LOG_NOTICE, Me)
-                                .UPS_Status = .UPS_Status Or UPS_States.CHRG
-                            Case "DISCHRG"
-                                LogFile.LogTracing("Battery is Discharging on UPS", LogLvl.LOG_NOTICE, Me)
-                                .UPS_Status = .UPS_Status Or UPS_States.DISCHRG
-                            Case "FSD"
-                                LogFile.LogTracing("Stop condition imposed by the NUT server", LogLvl.LOG_NOTICE, Me, WinNUT_Globals.StrLog.Item(AppResxStr.STR_LOG_NUT_FSD))
-                                .UPS_Status = .UPS_Status Or UPS_States.FSD
-                                RaiseEvent Shutdown_Condition()
-                            'ShutdownStatus = True
-                            Case "BYPASS"
-                                LogFile.LogTracing("UPS bypass circuit is active - no battery protection is available", LogLvl.LOG_NOTICE, Me)
-                                .UPS_Status = .UPS_Status Or UPS_States.BYPASS
-                            Case "CAL"
-                                LogFile.LogTracing("UPS is currently performing runtime calibration (on battery)", LogLvl.LOG_NOTICE, Me)
-                                .UPS_Status = .UPS_Status Or UPS_States.CAL
-                            Case "OFF"
-                                LogFile.LogTracing("UPS is offline and is not supplying power to the load", LogLvl.LOG_NOTICE, Me)
-                                .UPS_Status = .UPS_Status Or UPS_States.OFF
-                            Case "OVER"
-                                LogFile.LogTracing("UPS is overloaded", LogLvl.LOG_NOTICE, Me)
-                                .UPS_Status = .UPS_Status Or UPS_States.OVER
-                            Case "TRIM"
-                                LogFile.LogTracing("UPS is trimming incoming voltage", LogLvl.LOG_NOTICE, Me)
-                                .UPS_Status = .UPS_Status Or UPS_States.TRIM
-                            Case "BOOST"
-                                LogFile.LogTracing("UPS is boosting incoming voltage", LogLvl.LOG_NOTICE, Me)
-                                .UPS_Status = .UPS_Status Or UPS_States.BOOST
-                        End Select
-                    Next
+
+                    ' Prepare the status string for Enum parsing by replacing spaces with commas.
+                    UPS_rt_Status = UPS_rt_Status.Replace(" ", ",")
+                    Try
+                        .UPS_Status = [Enum].Parse(GetType(UPS_States), UPS_rt_Status)
+                    Catch ex As ArgumentException
+                        LogFile.LogTracing("Likely encountered an unknown/invalid UPS status. Using previous status." &
+                                           vbNewLine & ex.Message, LogLvl.LOG_ERROR, Me)
+                    End Try
+
+                    ' Get the difference between the old and new statuses, and filter only for active ones.
+                    Dim statusDiff = (oldStatusBitmask Xor .UPS_Status) And .UPS_Status
+
+                    If statusDiff = 0 Then
+                        LogFile.LogTracing("UPS statuses have not changed since last update, skipping.", LogLvl.LOG_DEBUG, Me)
+                    Else
+                        LogFile.LogTracing("UPS statuses have CHANGED, updating...", LogLvl.LOG_NOTICE, Me)
+                        oldStatusBitmask = .UPS_Status
+                        RaiseEvent StatusesChanged(Me, statusDiff)
+                    End If
                 End With
                 RaiseEvent DataUpdated()
             End If
@@ -419,7 +385,6 @@ Public Class UPS_Device
             'Me.Disconnect(True)
             'Enter_Reconnect_Process(Excep, "Error When Retrieve_UPS_Data : ")
         End Try
-        ' Return Me.UPSData
     End Sub
 
     Private Const MAX_VAR_RETRIES = 3