power off button enable/disable

Author: ECOM-Engineering

__pycache__/ups2_Interface.cpython-37.pyc

@@ -1,11 +1,22 @@
 # -*- coding: utf-8 -*-
+"""
+Graphical interface for UPS-2 UART serial mode.
+
+Usage:
+    * For autostart: put this script in /etc/xdg/lxsession/LXDE-pi/autostart
+    * This script needs PySimpleGUI.py found on https://github.com/PySimpleGUI/PySimpleGUI
+    * Raspberry serial interface must be enabled (with raspi-config) i.e.
+    * ups2_serial.py worker service must be started (instructions see docstring)
+"""
+#Todo: abs
+#    calendar timed functions
+#    email and/or other messaging functions
+
 import PySimpleGUI as sg
 import os
 import ups2_Interface as ups
 
-"""
-#for autostart: put this script in /etc/xdg/lxsession/LXDE-pi/autostart
-"""
+
 
 print('PySimpleGUI Version', sg.version)
 
@@ -14,7 +25,6 @@
 ser = ups.ecInitSerial()
 fT = open("/sys/class/thermal/thermal_zone0/temp", "r") #Pi processor temperature
 
-
 #globals
 bgOFF = 'lightgrey'
 bgOK =  '#A2C477'
@@ -28,7 +38,13 @@
 keyPiCPU = 'K_PI_T'
 
 def ecPopWin(count, title = 'ECOM UPS2'):
-#Open a modal popup for count seconds and return 'shutdown' or 'cancel'
+    '''Opens a modal popup for count seconds and returns "shutdown" or "cancel"
+
+    Args:
+        param count: countdown time in seconds    
+        param title: String to display in popup banner
+    
+    '''
 
     devider = count * 10
     layout2 = [[sg.Text('Pi shuddown in'),
@@ -59,7 +75,16 @@ def ecPopWin(count, title = 'ECOM UPS2'):
 
 
 def ecFormatDisplay(sysStatus, window):
-    #Set display attributes according to system state
+    '''Set display attributes according to system state.
+    
+    This function refreshes the display depending on the system state
+    Must be periodically called by the main control loop 
+
+    Args:
+        sysStatus:  string received from UPS-2 hardware
+        window:     initialized main window 
+    '''
+    
     s = int(sysStatus, 16) #sysStatus comes as string
 
     #default values. In dictionary in order to easily update depending on status  
@@ -81,7 +106,7 @@ def ecFormatDisplay(sysStatus, window):
     if s & 0x0020:    #batt V present
         battState.update(bgColor = bgOK, stat = 'OK')
     if s & 0x0040:    #usb V present
-        usbState.update(bgColor = bgOK, text = 'active')
+        usbState.update(bgColor = bgOK, text = 'active')     
     if (s & 0x0110) == 0x0110:    #main V LOW
         mainState.update(stat = 'LOW',   bgColor = bgLOW)
     if s & 0x0200:    #main V HIGH
@@ -92,9 +117,8 @@ def ecFormatDisplay(sysStatus, window):
         battState.update(stat = 'HIGH',  bgColor = bgHIGH)
     if s & 0x1000:    #CPU temp HIGH
         battState.update(stat = 'HIGH',  bgColor = bgHIGH)
-
 
-    #adapt elements        
+    #adapt value displays        
     window['K_MAIN_V'].update(background_color = mainState['bgColor'])
     window['K_MAIN_V'].Widget.configure(borderwidth = mainState['borderW']) #use underlying element
     window['K_MAIN_STATE'].update(mainState['stat'])
@@ -103,9 +127,15 @@ def ecFormatDisplay(sysStatus, window):
     window['K_BATT_STATE'].update(battState['stat'])
     window['K_USB'].update(background_color = usbState['bgColor'])
     window['K_USB'].update(usbState['text'])
+    #adapt power button
 
-    
-
+    if s & 0x0004:
+ #      window['Power OFF'].set_tooltip('Disabled, if USB 5V supplied')
+       window['Power OFF'].update(disabled=True, disabled_button_color=('lightgrey', 'none'))
+ 
+    else:
+        window['Power OFF'].update(disabled=False)
+ #       window['Power OFF'].SetTooltip('')
 
 # Main window column layout
 col1 = [[sg.Text(text='Main supply', key="K_MAIN_LBL", size=(10,0), justification='right')],
@@ -130,7 +160,7 @@ def ecFormatDisplay(sysStatus, window):
 mainFrame = [[ sg.Column(col1), sg.Column(col2), sg.Column(col3), sg.Column(col4), sg.Column(col5)]]
 
 #buttons to appear in frame below
-keypanel = [[sg.Button('Power OFF'), sg.Button('Restart'), sg.Button('Standby'), sg.Button('Quit')]]
+keypanel = [[sg.Button('Power OFF', tooltip='Disabled if USB powered'), sg.Button('Restart'), sg.Button('Standby'), sg.Button('Quit')]]
 
 #frame layout around buttons
 layout = [[sg.Frame('Power Supply Overview', mainFrame)],

__pycache__/ups2_serial.cpython-37.pyc

@@ -1,7 +1,15 @@
+"""Module containimg functions for serial communication with UPS-2 power supply.
+
+Module ups2_serial.py must be active in background.
+"""
+
 import serial
 import fcntl
 
 def ecInitSerial(device = '/dev/serial0'):
+    '''Opens serial device and returns a handle to to the device'''
+
+
     ser = serial.Serial(
     port= device,
     baudrate = 38400,
@@ -15,7 +23,7 @@ def ecInitSerial(device = '/dev/serial0'):
     return ser
 
 def ecReadline(ser):
-    """Returns a string from serial line until a '\n' chahacter"""
+    """Returns a string from serial line until a <CR> character."""
     rxLine = ""
     charCount = 0
     while True:
@@ -28,8 +36,9 @@ def ecReadline(ser):
                 charCount +=1
                 rxLine +=rxChar.decode("ascii")
 
-def ecFormatAnalog(analogStr = '0.0,0.0.25'):
-### format 'main,batt,temp' into list ###
+def ecFormatAnalog(analogStr):
+    '''Add units to analogStr 'main,batt,temp' and return as a list.'''
+
     units = ('V ','V ','°C')
     l = []
     v = analogStr.split(',')
@@ -38,6 +47,7 @@ def ecFormatAnalog(analogStr = '0.0,0.0.25'):
     return l                 
 
 def ecGetUPSValues(ser):
+    '''Requests values from UPS-2 by serial interface service ups2_serial.py.'''
     try:
         request = "r?status\n"
         fcntl.flock(ser, fcntl.LOCK_EX)
@@ -58,6 +68,8 @@ def ecGetUPSValues(ser):
         pass
 
 def ecReqUPSPowerDown(ser):
+    '''Initiates a Pi shutdown and executes power off after Pi is down'''
+    
     ack =''
     try:
         request = "r?shutdown -P\n"
@@ -70,4 +82,3 @@ def ecReqUPSPowerDown(ser):
     except:
         print("exception happended @ ecReqUPSPowerDown()")
     pass   
-

ups2_GUI.py

@@ -1,12 +1,16 @@
-#worker service, to call in /etc/rc.local
+"""
+Place a call to this service in /etc/rc.local:
+python3 /path/to/ups2_serial.py &
+"""
+
 import serial
 import time
 import sys
 import os
 import fcntl
 
 def ecReadline(ser):
-    """Returns a string from serial line until a '\n' chahacter"""
+    """Returns a string from serial line until a <CR> chahacter."""
     rxLine = ""
     charCount = 0
     while True:
@@ -22,17 +26,18 @@ def ecReadline(ser):
 
 
 def ecExecSerCommand(rxLine):
-    """check if command from UPS"""
+    """Check if command comes from UPS and execute."""
     command = "--"
      #linux system commands from UPS
     if rxLine[0:2] == "u!":  #prefix 
         command = rxLine[2:]
         command = "sudo " + command
+        #acknowledge before executing shutdown
         ackString = ">OK " + command + "\n"
         ser.write(str(ackString).encode())
         time.sleep(1) #give UPS a chance to read the ack String
  #       ser.send_break(1000.0) 
-        os.system(str(command).encode())
+        os.system(str(command).encode()) #this will normally execute a shutdown command
 
     else:
         if rxLine[0:2] == "u?": 
@@ -43,13 +48,12 @@ def ecExecSerCommand(rxLine):
     print("Command = " + command)
     return ""
 
-            
 
 #        os.system(command)
- 
 
 if __name__ == "__main__":
     #ser = serial.Serial('/dev/serial0', 38400, timeout = 1) # ttyACM1 for Arduino board
+    """ This service handles serial communication with ECOM UPS-2 power supply. """
     ser = serial.Serial(
     port='/dev/serial0',
     baudrate = 38400,
@@ -76,17 +80,20 @@ def ecExecSerCommand(rxLine):
     charCount = 0
     while True:
         try:
+            #lock serial interface in order to prevent interfering by other tasks
             fcntl.flock(ser, fcntl.LOCK_EX)
             rxLine = ecReadline(ser)
 #            fcntl.flock(ser, fcntl.LOCK_UN)
             rxLine = ecExecSerCommand(rxLine)
+            #unlock interface after processing rx data
             fcntl.flock(ser, fcntl.LOCK_UN)
             time.sleep(1.5) ##allow serial port by other process 
             rxLine +=rxChar.decode("ascii")
         except:
             pass
     print ("Restart")
-    ser.flush() #flush the buffer
+    #following code should never be executed
+    ser.flush() #clean up
     ser.close()