@@ -5,13 +5,12 @@

 # Module: radmonAgent.py

 #

 # Description: This module acts as an agent between the radiation monitoring

-# device and the Internet web server.  The agent periodically sends an http

+# device and Internet web services.  The agent periodically sends an http

 # request to the radiation monitoring device and processes the response from

 # the device and performs a number of operations:

-#     - conversion of data itemsq

+#     - conversion of data items

 #     - update a round robin (rrdtool) database with the radiation data

 #     - periodically generate graphic charts for display in html documents

-#     - forward the radiation data to other services

 #     - write the processed weather data to a JSON file for use by html

 #       documents

 #

@@ -56,7 +55,7 @@ _USER = os.environ['USER']

 _DEFAULT_RADIATION_MONITOR_URL = "{your radiation monitor url}"

 # url if this is a mirror server

 _PRIMARY_SERVER_URL = "{your primary server url}" \

-                      "/{user}/radmon/dynamic/radmonInputData.dat"

+                      "/radmon/dynamic/radmonInputData.dat"

     ### FILE AND FOLDER LOCATIONS ###

@@ -72,6 +71,7 @@ _OUTPUT_DATA_FILE = _DOCROOT_PATH + "dynamic/radmonOutputData.js"

 _RRD_FILE = "/home/%s/database/radmonData.rrd" % _USER

     ### GLOBAL CONSTANTS ###

+

 # max number of failed data requests allowed

 _MAX_FAILED_DATA_REQUESTS = 2

 # interval in seconds between data requests to radiation monitor

@@ -91,10 +91,16 @@ _CHART_HEIGHT = 150

 # turn on or off of verbose debugging information

 debugOption = False

-# used for detecting system faults and radiation monitor

-# online or offline status

+verboseDebug = False

+

+# The following two items are used for detecting system faults

+# and radiation monitor online or offline status.

+

+# count of failed attempts to get data from radiation monitor

 failedUpdateCount = 0

+# detected status of radiation monitor device

 stationOnline = True

+

 # status of reset command to radiation monitor

 remoteDeviceReset = False

 # ip address of radiation monitor

@@ -106,41 +112,49 @@ dataRequestInterval = _DEFAULT_DATA_REQUEST_INTERVAL

 def getTimeStamp():

     """

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

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

     Parameters: none

-    Returns string containing the time stamp.

+    Returns: string containing the time stamp

     """

     return time.strftime( "%m/%d/%Y %T", time.localtime() )

 ##end def

 def setStatusToOffline():

-    """Set the status of the the upstream device to "offline" and sends

-       blank data to the downstream clients.

-       Parameters:

-           dData - dictionary object containing weather data

-       Returns nothing.

+    """Set the detected status of the radiation monitor to

+       "offline" and inform downstream clients by removing input

+       and output data files.

+       Parameters: none

+       Returns: nothing

     """

     global stationOnline

+    # Inform downstream clients by removing input and output

+    # data files.

     if os.path.exists(_INPUT_DATA_FILE):

         os.remove(_INPUT_DATA_FILE)

     if os.path.exists(_OUTPUT_DATA_FILE):

        os.remove(_OUTPUT_DATA_FILE)

-    # If the radiation monitor was previously online, then send a message

-    # that we are now offline.

+    # If the radiation monitor was previously online, then send

+    # a message that we are now offline.

     if stationOnline:

         print '%s radiation monitor offline' % getTimeStamp()

     stationOnline = False

 ##end def

 def terminateAgentProcess(signal, frame):

-    """Send message to log when process killed

-       Parameters: signal, frame - sigint parameters

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

+       by the operating system.  Inform downstream clients

+       by removing input and output data files.

+       Parameters:

+           signal, frame - dummy parameters

        Returns: nothing

     """

     print '%s terminating radmon agent process' % \

               (getTimeStamp())

+

+    # Inform downstream clients by removing input and output

+    # data files.

     if os.path.exists(_OUTPUT_DATA_FILE):

         os.remove(_OUTPUT_DATA_FILE)

     if os.path.exists(_INPUT_DATA_FILE):

@@ -151,15 +165,12 @@ def terminateAgentProcess(signal, frame):

   ###  PUBLIC METHODS  ###

 def getRadiationData():

-    """Send http request to radiation monitoring device.  The response

-       from the device contains the radiation data.  The data is formatted

-       as an html document.

-    Parameters: 

-        radiationMonitorUrl - url of radiation monitoring device

-        HttpRequesttimeout - how long to wait for device

-                             to respond to http request

-    Returns a string containing the radiation data, or None if

-    not successful.

+    """Send http request to radiation monitoring device.  The

+       response from the device contains the radiation data as

+       unformatted ascii text.

+       Parameters: none 

+       Returns: a string containing the radiation data if successful,

+                or None if not successful

     """

     global remoteDeviceReset

@@ -168,9 +179,9 @@ def getRadiationData():

     else:

         sUrl = radiationMonitorUrl

         if remoteDeviceReset:

-            sUrl += "/reset"

+            sUrl += "/reset" # reboot the radiation monitor

         else:

-            sUrl += "/rdata"

+            sUrl += "/rdata" # request data from the monitor