@@ -7,7 +7,7 @@

 # Description: Creates a rrdtool database for use by the power agent to

 # store the data from the power and temperature sensors.  The agent uses

 # the data in the database to generate graphic charts for display in the

-# weather station web page.

+# node power web page.

 #

 # Copyright 2021 Jeff Owrey

 #    This program is free software: you can redistribute it and/or modify

@@ -38,32 +38,40 @@ CUR_REG = 0x1

 VOLT_REG = 0x2

 PWR_REG = 0x3

+# Define default sm bus address.

+DEFAULT_BUS_ADDRESS = 0x40

+DEFAULT_BUS_NUMBER = 1

+

+# Define the default sensor configuration.  See the INA260 data sheet

+# for meaning of each bit.  The following bytes are written to the

+# configuration register

+#     byte 1: 11100000

+#     byte 2: 00100111

+DEFAULT_CONFIG = 0xE027

+

 class ina260:

     # Initialize the INA260 sensor at the supplied address (default

     # address is 0x40), and supplied bus (default is 1).  Creates

     # a new SMBus object for each instance of this class.  Writes

     # configuration data (two bytes) to the INA260 configuration

     # register.

-    def __init__(self, sAddr=0x40, sbus=1):

-        # Instantiate a smbus object

+    def __init__(self, sAddr=DEFAULT_BUS_ADDRESS,

+                       sbus=DEFAULT_BUS_NUMBER,

+                       config=DEFAULT_CONFIG):

+        # Instantiate a smbus object.

         self.sensorAddr = sAddr

         self.bus = smbus.SMBus(sbus)

-        # Initialize INA260 sensor.  See the data sheet for meaning of

-        # each bit.  The following bytes are written to the configuration

-        # register

-        #     byte 1: 11100000

-        #     byte 2: 00100111

-        initData = [0b11100000, 0b00100111]

-        #initData = [0x60, 0x27]

+        # Initialize INA260 sensor.  

+        initData = [(config >> 8), (config & 0x00FF)]

         self.bus.write_i2c_block_data(self.sensorAddr, CONFIG_REG, initData)

     ## end def

     def status(self):

-        # Read configuration data

+        # Read manufacture identification data.

         mfcid = self.bus.read_i2c_block_data(self.sensorAddr, ID_REG, 2)

         mfcidB1 = format(mfcid[0], "08b")

         mfcidB2 = format(mfcid[1], "08b")

-        # Read configuration data

+        # Read configuration data.

         config = self.bus.read_i2c_block_data(self.sensorAddr, CONFIG_REG, 2)

         configB1 = format(config[0], "08b")

         configB2 = format(config[1], "08b")

@@ -97,9 +105,9 @@ class ina260:

         # Convert from two's complement to integer.

         # If d15 is 1, the the number is a negative two's complement

         # number.  The absolute value is 2^16 - 1 minus the value

-        # of d14-d0 taken as a positive number.

+        # of d15-d0 taken as a positive number.

         if bdata > 0x7FFF:

-            bdata = -(0xFFFF - bdata) # 0xFFFF is 2^16 - 1

+            bdata = -(0xFFFF - bdata) # 0xFFFF equals 2^16 - 1

         # Convert integer data to mAmps.

         mAmps = bdata * 1.25  # LSB is 1.25 mA

         return mAmps

@@ -154,14 +162,14 @@ def test():

     pwr1 = ina260(0x40, 1)

     # Read the INA260 configuration register and manufacturer's ID.

     data = pwr1.status()

-    print "manufacturer ID: %s %s\nconfiguration register: %s %s\n" % data

+    print("manufacturer ID: %s %s\nconfiguration register: %s %s\n" % data)

     # Print out sensor values.

     while True:

-        print "current register: %s %s" % pwr1.getCurrentReg()

-        print "%6.2f mA" % pwr1.getCurrent()

-        print "volt register: %s %s" % pwr1.getVoltageReg()

-        print "%6.2f V" % pwr1.getVoltage()

-        print "%6.2f mW\n" % pwr1.getPower()

+        print("current register: %s %s" % pwr1.getCurrentReg())

+        print("%6.2f mA" % pwr1.getCurrent())

+        print("volt register: %s %s" % pwr1.getVoltageReg())

+        print("%6.2f V" % pwr1.getVoltage())

+        print("%6.2f mW\n" % pwr1.getPower())

         time.sleep(2)

 ## end def

@@ -39,11 +39,15 @@ import signal

 import subprocess

 import multiprocessing

 import time

+import json

 # Import sensor libraries.

 import ina260 # power sensor

 import tmp102 # temperature sensor

+    ### ENVIRONMENT ###

+_USER = os.environ['USER']

+

     ### SENSOR BUS ADDRESSES ###

 # Set bus addresses of sensors.

@@ -55,8 +59,7 @@ _BUS_SEL = 1

     ### FILE AND FOLDER LOCATIONS ###

-_USER = os.environ['USER']

-# folder to contain dynamic data objects

+# folder to contain html

 _DOCROOT_PATH = "/home/%s/public_html/power/" % _USER

 # folder to contain charts and output data file

 _CHARTS_DIRECTORY = _DOCROOT_PATH + "dynamic/"

@@ -67,10 +70,10 @@ _RRD_FILE = "/home/%s/database/powerData.rrd" % _USER

     ### GLOBAL CONSTANTS ###

-# rrdtool database update interval in seconds

-_DATABASE_UPDATE_INTERVAL = 30

 # sensor data request interval in seconds

 _DEFAULT_DATA_REQUEST_INTERVAL = 2

+# rrdtool database update interval in seconds

+_DATABASE_UPDATE_INTERVAL = 30

 # chart update interval in seconds

 _CHART_UPDATE_INTERVAL = 600

 # standard chart width in pixels

@@ -85,6 +88,7 @@ _AVERAGE_LINE_COLOR = '#006600'

 # debug output options

 debugOption = False

 verboseDebug = False

+

 # frequency of data requests to sensors

 dataRequestInterval = _DEFAULT_DATA_REQUEST_INTERVAL

 # how often charts get updated

@@ -101,7 +105,7 @@ atmp = tmp102.tmp102(_AMB_TMP_SENSOR_ADDR, _BUS_SEL)

 def getTimeStamp():

     """

-    Set the error message time stamp to the local system time.

+    Get the local time and format as a text string.

     Parameters: none

     Returns: string containing the time stamp

     """

@@ -109,57 +113,58 @@ def getTimeStamp():

 ## end def

 def getEpochSeconds(sTime):

-    """Convert the time stamp supplied in the weather data string

-       to seconds since 1/1/1970 00:00:00.

-       Parameters: 

-           sTime - the time stamp to be converted must be formatted

+    """

+    Convert the time stamp to seconds since 1/1/1970 00:00:00.

+    Parameters: 

+        sTime - the time stamp to be converted must be formatted

                    as %m/%d/%Y %H:%M:%S

-       Returns: epoch seconds

+    Returns: epoch seconds

     """

     try:

         t_sTime = time.strptime(sTime, '%m/%d/%Y %H:%M:%S')

-    except Exception, exError:

-        print '%s getEpochSeconds: %s' % (getTimeStamp(), exError)

+    except Exception as exError:

+        print('%s getEpochSeconds: %s' % (getTimeStamp(), exError))

         return None

     tSeconds = int(time.mktime(t_sTime))

     return tSeconds

 ## end def

 def terminateAgentProcess(signal, frame):

-    """Send a message to the log when the agent process gets killed

-       by the operating system.  Inform downstream clients

-       by removing output data files.

-       Parameters:

-           signal, frame - dummy parameters

-       Returns: nothing

+    """

+    Send a message to the log when the agent process gets killed

+    by the operating system.  Inform downstream clients

+    by removing output data files.

+    Parameters:

+        signal, frame - dummy parameters

+    Returns: nothing

     """

     # Inform downstream clients by removing output data file.

     if os.path.exists(_OUTPUT_DATA_FILE):

        os.remove(_OUTPUT_DATA_FILE)

-    print '%s terminating npw agent process' % \

-              (getTimeStamp())

+    print('%s terminating npw agent process' % getTimeStamp())

     sys.exit(0)

 ## end def

   ###  PUBLIC METHODS  ###

 def getSensorData(dData):

-    """Poll sensors for data. Store the data in a dictionary object for

-       use by other subroutines.  The dictionary object passed in should

-       an empty dictionary, i.e., dData = { }.

-       Parameters: dData - a dictionary object to contain the sensor data

-       Returns: True if successful, False otherwise

     """

+    Poll sensors for data. Store the data in a dictionary object for

+    use by other subroutines.  The dictionary object passed in should

+    an empty dictionary, i.e., dData = { }.

+    Parameters: dData - a dictionary object to contain the sensor data

+    Returns: True if successful, False otherwise

+    """

+    dData["time"] = getTimeStamp()

+ 

     try:

-        dData["time"] = getTimeStamp()

         dData["current"] = pwr.getCurrent()

         dData["voltage"] = pwr.getVoltage()

         dData["power"] = pwr.getPower()

         dData["battemp"] = btmp.getTempF()

         dData["ambtemp"] = atmp.getTempF()

-     

-    except Exception, exError:

-        print "%s sensor error: %s" % (getTimeStamp(), exError)

+    except Exception as exError:

+        print("%s sensor error: %s" % (getTimeStamp(), exError))

         return False

     return True

@@ -182,29 +187,33 @@ def updateDatabase(dData):

              dData['voltage'], dData['power'], dData['battemp'], \

              dData['ambtemp'])

-    if debugOption:

-        print "%s" % strCmd # DEBUG

+    if verboseDebug:

+        print("%s" % strCmd) # DEBUG

     # Run the command as a subprocess.

     try:

-        subprocess.check_output(strCmd, shell=True,  \

-                             stderr=subprocess.STDOUT)

-    except subprocess.CalledProcessError, exError:

-        print "%s: rrdtool update failed: %s" % \

-                    (getTimeStamp(), exError.output)

+        subprocess.check_output(strCmd, shell=True, \

+            stderr=subprocess.STDOUT)

+    except subprocess.CalledProcessError as exError:

+        print("%s: rrdtool update failed: %s" % \

+            (getTimeStamp(), exError.output))

         return False

+    if debugOption and not verboseDebug:

+        print("database updated")

+

     return True

 ## end def

-def writeOutputDataFile(dData):

-    """Write node data items to the output data file, formatted as 

-       a Javascript file.  This file may then be requested and used by

-       by downstream clients, for instance, an HTML document.

-       Parameters:

-           dData - a dictionary containing the data to be written

+def writeOutputFile(dData):

+    """

+    Write sensor data items to the output data file, formatted as 

+    a Javascript file.  This file may then be requested and used by

+    by downstream clients, for instance, an HTML document.

+    Parameters:

+        dData - a dictionary containing the data to be written

                    to the output data file

-       Returns: True if successful, False otherwise

+        Returns: True if successful, False otherwise

     """

     # Write a JSON formatted file for use by html clients.  The following

     # data items are sent to the client file.

@@ -213,54 +222,58 @@ def writeOutputDataFile(dData):

     #    * The sensor values

     # Create a JSON formatted string from the sensor data.

-    sData = "[{\"period\":\"%s\", " % \

-           (chartUpdateInterval)

-    for key in dData:

-        sData += '\"%s\":\"%s\", ' % (key, dData[key])

-    sData = sData[:-2] + '}]\n'

+    try:

+        jsData = json.loads("{}")

+        for key in dData:

+            jsData.update({key:dData[key]})

+        jsData.update({"chartUpdateInterval": chartUpdateInterval})

+        sData = "[%s]" % json.dumps(jsData)

+    except Exception as exError:

+        print("%s writeOutputFile: %s" % (getTimeStamp(), exError))

+        return False

+

+    if verboseDebug:

+        print(sData)

     # Write the JSON formatted data to the output data file.

+

     try:

         fc = open(_OUTPUT_DATA_FILE, "w")

         fc.write(sData)

         fc.close()

-    except Exception, exError:

-        print "%s write output file failed: %s" % \

-              (getTimeStamp(), exError)

+    except Exception as exError:

+        print("%s write output file failed: %s" % \

+              (getTimeStamp(), exError))

         return False

-    if verboseDebug:

-        print sData[:-1]

-    if debugOption:

-        print "writing output data file: %d bytes" % len(sData)

-

     return True

 ## end def

 def createGraph(fileName, dataItem, gLabel, gTitle, gStart,

                 lower=0, upper=0, trendLine=0, scaleFactor=1,

                 autoScale=True, alertLine=""):

-    """Uses rrdtool to create a graph of specified node data item.

-       Parameters:

-           fileName - name of file containing the graph

-           dataItem - data item to be graphed

-           gLabel - string containing a graph label for the data item

-           gTitle - string containing a title for the graph

-           gStart - beginning time of the graphed data

-           lower - lower bound for graph ordinate #NOT USED

-           upper - upper bound for graph ordinate #NOT USED

-           trendLine 

-                0, show only graph data

-                1, show only a trend line

-                2, show a trend line and the graph data

-           scaleFactor - amount to pre-scale the data before charting

-                the data [default=1]

-           autoScale - if True, then use vertical axis auto scaling

-                (lower and upper parameters must be zero)

-           alertLine - value for which to print a critical

-                low voltage alert line on the chart. If not provided

-                alert line will not be printed.

-       Returns: True if successful, False otherwise

+    """

+    Uses rrdtool to create a graph of specified sensor data item.

+    Parameters:

+        fileName - name of file containing the graph

+        dataItem - data item to be graphed

+        gLabel - string containing a graph label for the data item

+        gTitle - string containing a title for the graph

+        gStart - beginning time of the graphed data

+        lower - lower bound for graph ordinate #NOT USED

+        upper - upper bound for graph ordinate #NOT USED

+        trendLine 

+            0, show only graph data

+            1, show only a trend line

+            2, show a trend line and the graph data

+        scaleFactor - amount to pre-scale the data before charting

+            the data [default=1]

+        autoScale - if True, then use vertical axis auto scaling

+            (lower and upper parameters must be zero)

+        alertLine - value for which to print a critical

+            low voltage alert line on the chart. If not provided

+            alert line will not be printed.

+    Returns: True if successful, False otherwise

     """

     gPath = _CHARTS_DIRECTORY + fileName + ".png"

     trendWindow = { 'end-1day': 7200,

@@ -302,27 +315,28 @@ def createGraph(fileName, dataItem, gLabel, gTitle, gStart,

         strCmd += "HRULE:%s#FF0000:Critical\ Low\ Voltage " % (alertLine)

     if verboseDebug:

-        print "%s" % strCmd # DEBUG

+        print("%s" % strCmd) # DEBUG

     # Run the formatted rrdtool command as a subprocess.

     try:

         result = subprocess.check_output(strCmd, \

                      stderr=subprocess.STDOUT,   \

                      shell=True)

-    except subprocess.CalledProcessError, exError:

-        print "rrdtool graph failed: %s" % (exError.output)

+    except subprocess.CalledProcessError as exError:

+        print("rrdtool graph failed: %s" % (exError.output))

         return False

     if debugOption:

-        print "rrdtool graph: %s\n" % result,

+        print("rrdtool graph: %s" % result.decode('utf-8'))

     return True

 ## end def

 def generateGraphs():

-    """Generate graphs for display in html documents.

-       Parameters: none

-       Returns: nothing

+    """

+    Generate graphs for display in html documents.

+    Parameters: none

+    Returns: nothing

     """

     # 24 hour stock charts

@@ -381,12 +395,13 @@ def generateGraphs():

 ## end def

 def getCLarguments():

-    """Get command line arguments.  There are three possible arguments

-          -d turns on debug mode

-          -v turns on verbose debug mode

-          -p sets the sensor query period

-          -c sets the chart update period

-       Returns: nothing

+    """

+    Get command line arguments.  There are three possible arguments

+        -d turns on debug mode

+        -v turns on verbose debug mode

+        -p sets the sensor query period

+        -c sets the chart update period

+    Returns: nothing

     """

     global debugOption, verboseDebug, dataRequestInterval, chartUpdateInterval

@@ -401,36 +416,37 @@ def getCLarguments():

             try:

                 dataRequestInterval = abs(int(sys.argv[index + 1]))

             except:

-                print "invalid sensor query period"

+                print("invalid sensor query period")

                 exit(-1)

             index += 1

         elif sys.argv[index] == '-c':

             try:

                 chartUpdateInterval = abs(int(sys.argv[index + 1]))

             except:

-                print "invalid chart update period"

+                print("invalid chart update period")

                 exit(-1)

             index += 1

         else:

             cmd_name = sys.argv[0].split('/')

-            print "Usage: %s [-d | v] [-p seconds] [-c seconds]" \

-                  % cmd_name[-1]

+            print("Usage: %s [-d | v] [-p seconds] [-c seconds]" \

+                  % cmd_name[-1])

             exit(-1)

         index += 1

 ##end def

 def main():

-    """Handles timing of events and acts as executive routine managing

-       all other functions.

-       Parameters: none

-       Returns: nothing

+    """

+    Handles timing of events and acts as executive routine managing

+    all other functions.

+    Parameters: none

+    Returns: nothing

     """

     global dataRequestInterval

     signal.signal(signal.SIGTERM, terminateAgentProcess)

+    signal.signal(signal.SIGINT, terminateAgentProcess)

-    print '%s starting up node power agent process' % \

-                  (getTimeStamp())

+    print('%s starting up node power agent process' % getTimeStamp())

     # last time output JSON file updated

     lastDataRequestTime = -1

@@ -444,9 +460,9 @@ def main():

     ## Exit with error if rrdtool database does not exist.

     if not os.path.exists(_RRD_FILE):

-        print 'rrdtool database does not exist\n' \

-              'use createArednsigRrd script to ' \

-              'create rrdtool database\n'

+        print('rrdtool database does not exist\n' \

+              'use createPowerRrd script to ' \

+              'create rrdtool database\n')

         exit(1)

     ## main loop

@@ -454,8 +470,8 @@ def main():

         currentTime = time.time() # get current time in seconds

-        # Every web update interval request data from the aredn

-        # node and process the received data.

+        # Every data request interval read the sensors and process the

+        # data from the sensors.

         if currentTime - lastDataRequestTime > dataRequestInterval:

             lastDataRequestTime = currentTime

             dData = {}

@@ -466,17 +482,14 @@ def main():

             # If get data successful, write data to data files.

             if result:

-                result = writeOutputDataFile(dData)

-                pass

+                result = writeOutputFile(dData)

             # At the rrdtool database update interval, update the database.

-            if currentTime - lastDatabaseUpdateTime > \

-                    _DATABASE_UPDATE_INTERVAL:   

+            if result and (currentTime - lastDatabaseUpdateTime > \

+                           _DATABASE_UPDATE_INTERVAL):   

                 lastDatabaseUpdateTime = currentTime

                 ## Update the round robin database with the parsed data.

-                if result:

-                    updateDatabase(dData)

-                    pass

+                result = updateDatabase(dData)

         # At the chart generation interval, generate charts.

         if currentTime - lastChartUpdateTime > chartUpdateInterval:

@@ -490,10 +503,11 @@ def main():

         elapsedTime = time.time() - currentTime

         if debugOption:

             if result:

-                print "%s update successful:" % getTimeStamp(),

+                print("update successful: %6f sec\n"

+                      % elapsedTime)

             else:

-                print "%s update failed:" % getTimeStamp(),

-            print "%6f seconds processing time\n" % elapsedTime 

+                print("update failed: %6f sec\n"

+                      % elapsedTime)

         remainingTime = dataRequestInterval - elapsedTime

         if remainingTime > 0.0:

             time.sleep(remainingTime)

@@ -502,8 +516,4 @@ def main():

 ## end def

 if __name__ == '__main__':

-    try:

-        main()

-    except KeyboardInterrupt:

-        print '\n',

-        terminateAgentProcess('KeyboardInterrupt','Module')

+    main()

@@ -1,5 +1,6 @@

 #!/bin/bash

-#

+# Starts up the node power agent as a background process

+# and redirects output to a log file.

 APP_PATH="/home/$USER/bin"

 LOG_PATH="/home/$USER/log"

@@ -1,5 +1,5 @@

 #!/bin/bash

-# Stop the radmon agent process and clean up environment.

+# Stop the node power agent process and clean up environment.

 AGENT_NAME="[n]pwAgent.py"

@@ -1,4 +1,4 @@

-#!/usr/bin/python

+#!/usr/bin/python2

 #

 # Module: tmp102.py

 #

@@ -31,12 +31,23 @@ import smbus

 import time

 # Define constants

-DEGSYM = u'\xb0'

+DEGSYM = u'\xB0'

 # Define TMP102 Device Registers

 CONFIG_REG = 0x1

 TEMP_REG = 0x0

+# Define default sm bus address.

+DEFAULT_BUS_ADDRESS = 0x48

+DEFAULT_BUS_NUMBER = 1

+

+# Define the default sensor configuration.  See the TMP102 data sheet

+# for meaning of each bit.  The following bytes are written to the

+# configuration register

+#     byte 1: 01100000

+#     byte 2: 10100000

+DEFAULT_CONFIG = 0x60A0

+

 class tmp102:

     # Initialize the TMP102 sensor at the supplied address (default

@@ -44,16 +55,14 @@ class tmp102:

     # a new SMBus object for each instance of this class.  Writes

     # configuration data (two bytes) to the TMP102 configuration

     # register.

-    def __init__(self, sAddr=0x48, sbus=1): 

+    def __init__(self, sAddr=DEFAULT_BUS_ADDRESS,

+                 sbus=DEFAULT_BUS_NUMBER,

+                 config=DEFAULT_CONFIG): 

         # Instantiate a smbus object

         self.sensorAddr = sAddr

         self.bus = smbus.SMBus(sbus)

-        # Initialize TMP102 sensor.  See the data sheet for meaning of

-        # each bit.  The following bytes are written to the configuration

-        # register

-        #     byte 1: 01100000

-        #     byte 2: 10100000

-        initData = [0x60, 0xA0]

+        # Initialize TMP102 sensor.  

+        initData = [(config >> 8), (config & 0x00FF)]

         self.bus.write_i2c_block_data(self.sensorAddr, CONFIG_REG, initData)

     ## end def

@@ -95,7 +104,7 @@ class tmp102:

         # Convert from two's complement to integer.

         # If d11 is 1, the the number is a negative two's complement

         # number.  The absolute value is 2^12 - 1 minus the value

-        # of d10-d0 taken as a positive number.

+        # of d11-d0 taken as a positive number.

         if bData > 0x7FF:  # all greater values are negative numbers

             bData = -(0xFFF - bData)  # 0xFFF is 2^12 - 1

         # convert integer data to Celsius

@@ -124,14 +133,14 @@ def testclass():

         tempF = ts1.getTempF()

         if bAl:

             bAl = False

-            print "\033[42;30mTemperature Reg: %s %s\033[m" % regdata

-            print "\033[42;30m%6.2f%sC  %6.2f%s                 \033[m" % \

-                  (tempC, DEGSYM, tempF, DEGSYM)

+            print("\033[42;30mTemperature Reg: %s %s\033[m" % regdata)

+            print("\033[42;30m%6.2f%sC  %6.2f%s                 \033[m" % \

+                  (tempC, DEGSYM, tempF, DEGSYM))

         else:

             bAl = True

-            print "Temperature Reg: %s %s" % regdata

-            print "%6.2f%sC  %6.2f%sF" % \

-                  (tempC, DEGSYM, tempF, DEGSYM)

+            print("Temperature Reg: %s %s" % regdata)

+            print("%6.2f%sC  %6.2f%sF" % \

+                  (tempC, DEGSYM, tempF, DEGSYM))

         time.sleep(2)

     ## end while

 ## end def