Bugfix on documentation

[infoex-autowx.git] / infoex-autowx.py

diff --git a/infoex-autowx.py b/infoex-autowx.py
index 6594cc693612b24d14af1edb07d68200b35b7b59..f05939412945b367b39167c53e5c4572793862eb 100755 (executable)
--- a/infoex-autowx.py
+++ b/infoex-autowx.py
@@ -43,7 +43,7 @@ import zeep
 import zeep.cache
 import zeep.transports
 
 import zeep.cache
 import zeep.transports
 

-__version__ = '3.2.0'
+__version__ = '3.3.1'

 
 LOG = logging.getLogger(__name__)
 LOG.setLevel(logging.NOTSET)
 
 LOG = logging.getLogger(__name__)
 LOG.setLevel(logging.NOTSET)


@@ -128,9 +128,45 @@ def setup_config(config):
             LOG.critical("%s is not a valid timezone", tz)
             sys.exit(1)
 
             LOG.critical("%s is not a valid timezone", tz)
             sys.exit(1)
 

+        # By default, fetch three hours of data
+        #
+        # If user wants hn24 or wind averaging, then
+        # we need more.
+        station['num_hrs_to_fetch'] = 3
+
+        # HN24
+        if 'hn24' in config['station']:
+            if config['station']['hn24'] not in ['true', 'false']:
+                raise ValueError("hn24 must be either 'true' or 'false'")
+
+            if config['station']['hn24'] == "true":
+                station['hn24'] = True
+                station['num_hrs_to_fetch'] = 24
+            else:
+                station['hn24'] = False
+        else:
+            # default to False
+            station['hn24'] = False
+
+        # Wind mode
+        if 'wind_mode' in config['station']:
+            if config['station']['wind_mode'] not in ['normal', 'average']:
+                raise ValueError("wind_mode must be either 'normal' or 'average'")
+
+            station['wind_mode'] = config['station']['wind_mode']
+
+            if station['wind_mode'] == "average":
+                station['num_hrs_to_fetch'] = 24
+        else:
+            # default to False
+            station['wind_mode'] = "normal"
+

     except KeyError as err:
         LOG.critical("%s not defined in configuration file", err)
         sys.exit(1)
     except KeyError as err:
         LOG.critical("%s not defined in configuration file", err)
         sys.exit(1)

+    except ValueError as err:
+        LOG.critical("%s", err)
+        sys.exit(1)

 
     # all sections/values present in config file, final sanity check
     try:
 
     # all sections/values present in config file, final sanity check
     try:


@@ -155,6 +191,11 @@ def setup_logging(log_level):
         #LOG.addHandler(logging.handlers.SysLogHandler())
         # fallback to stdout
         handler = logging.StreamHandler(sys.stdout)
         #LOG.addHandler(logging.handlers.SysLogHandler())
         # fallback to stdout
         handler = logging.StreamHandler(sys.stdout)

+        formatter = logging.Formatter('%(asctime)s.%(msecs)03d '
+                                      '%(levelname)s %(module)s - '
+                                      '%(funcName)s: %(message)s',
+                                      '%Y-%m-%d %H:%M:%S')
+        handler.setFormatter(formatter)

         LOG.addHandler(handler)
 
     # ugly, but passable
         LOG.addHandler(handler)
 
     # ugly, but passable


@@ -200,13 +241,7 @@ def main():
     iemap = setup_infoex_counterparts_mapping(station['provider'])
 
     # override units if user selected metric
     iemap = setup_infoex_counterparts_mapping(station['provider'])
 
     # override units if user selected metric

-    if 'units' not in station:
-        if station['provider'] != 'python':
-            LOG.error("Please specify the units in the configuration "
-                      "file")
-            sys.exit(1)
-
-    if station['units'] == 'metric':
+    if station['provider'] != 'python' and station['units'] == 'metric':

         final_data = switch_units_to_metric(final_data, fmap)
 
     (begin_date, end_date) = setup_time_values(station)
         final_data = switch_units_to_metric(final_data, fmap)
 
     (begin_date, end_date) = setup_time_values(station)


@@ -277,6 +312,9 @@ def main():
             LOG.warning("BAD KEY wx_data['%s']", element_cd)
             continue
 
             LOG.warning("BAD KEY wx_data['%s']", element_cd)
             continue
 

+        if infoex['wx_data'][element_cd] is None:
+            continue
+

         # do the conversion before the rounding
         if station['provider'] == 'nrcs' and station['units'] == 'metric':
             infoex['wx_data'][element_cd] = convert_nrcs_units_to_metric(element_cd, infoex['wx_data'][element_cd])
         # do the conversion before the rounding
         if station['provider'] == 'nrcs' and station['units'] == 'metric':
             infoex['wx_data'][element_cd] = convert_nrcs_units_to_metric(element_cd, infoex['wx_data'][element_cd])


@@ -288,14 +326,15 @@ def main():
         #                   direction, wind gust, snow depth
         # 1 decimal place:  air temp, baro
         # Avoid transforming None values
         #                   direction, wind gust, snow depth
         # 1 decimal place:  air temp, baro
         # Avoid transforming None values

-        if infoex['wx_data'][element_cd] is None:
-            continue
-        elif element_cd in ['wind_speed', 'WSPD', 'wind_direction',
-                            'RHUM', 'relative_humidity', 'WDIR',
-                            'wind_gust', 'SNWD', 'snow_depth']:
+        if element_cd in ['wind_speed', 'WSPD', 'wind_direction',
+                          'RHUM', 'relative_humidity', 'WDIR',
+                          'wind_gust', 'SNWD', 'snow_depth',
+                          'hn24']:

             infoex['wx_data'][element_cd] = round(infoex['wx_data'][element_cd])
         elif element_cd in ['TOBS', 'air_temp', 'PRES', 'pressure']:
             infoex['wx_data'][element_cd] = round(infoex['wx_data'][element_cd], 1)
             infoex['wx_data'][element_cd] = round(infoex['wx_data'][element_cd])
         elif element_cd in ['TOBS', 'air_temp', 'PRES', 'pressure']:
             infoex['wx_data'][element_cd] = round(infoex['wx_data'][element_cd], 1)

+        elif element_cd in ['PREC', 'precip_accum']:
+            infoex['wx_data'][element_cd] = round(infoex['wx_data'][element_cd], 2)

 
         # CONSIDER: Casting every value to Float() -- need to investigate if
         #           any possible elementCds we may want are any other data
 
         # CONSIDER: Casting every value to Float() -- need to investigate if
         #           any possible elementCds we may want are any other data


@@ -402,6 +441,10 @@ def setup_infoex_counterparts_mapping(provider):
         iemap['wind_speed'] = 'windSpeedNum'
         iemap['wind_direction'] = 'windDirectionNum'
         iemap['wind_gust'] = 'windGustSpeedNum'
         iemap['wind_speed'] = 'windSpeedNum'
         iemap['wind_direction'] = 'windDirectionNum'
         iemap['wind_gust'] = 'windGustSpeedNum'

+
+        # NOTE: this doesn't exist in MesoWest, we create it in this
+        #       program, so add it to the map here
+        iemap['hn24'] = 'hn24Auto'

     elif provider == 'python':
         # we expect Python programs to use the InfoEx data type names
         iemap['precipitationGauge'] = 'precipitationGauge'
     elif provider == 'python':
         # we expect Python programs to use the InfoEx data type names
         iemap['precipitationGauge'] = 'precipitationGauge'


@@ -468,7 +511,12 @@ def get_mesowest_data(begin, end, station):
 
     # construct final, completed API URL
     api_req_url = station['source'] + '&start=' + begin_date_str + '&end=' + end_date_str
 
     # construct final, completed API URL
     api_req_url = station['source'] + '&start=' + begin_date_str + '&end=' + end_date_str

-    req = requests.get(api_req_url)
+
+    try:
+        req = requests.get(api_req_url)
+    except requests.exceptions.ConnectionError:
+        LOG.error("Could not connect to '%s'", api_req_url)
+        sys.exit(1)

 
     try:
         json = req.json()
 
     try:
         json = req.json()


@@ -493,8 +541,21 @@ def get_mesowest_data(begin, end, station):
         LOG.error("Bad JSON in MesoWest response: '%s'", exc)
         sys.exit(1)
 
         LOG.error("Bad JSON in MesoWest response: '%s'", exc)
         sys.exit(1)
 

+    # pos represents the last item in the array, aka the most recent

     pos = len(observations['date_time']) - 1
 
     pos = len(observations['date_time']) - 1
 

+    # while these values only apply in certain cases, init them here
+    wind_speed_values = []
+    wind_gust_speed_values = []
+    wind_direction_values = []
+    hn24_values = []
+
+    # results
+    wind_speed_avg = None
+    wind_gust_speed_avg = None
+    wind_direction_avg = None
+    hn24 = None
+

     for element_cd in station['desired_data'].split(','):
         # sort and isolate the most recent, see note above in NRCS for how and
         # why this is done
     for element_cd in station['desired_data'].split(','):
         # sort and isolate the most recent, see note above in NRCS for how and
         # why this is done


@@ -513,19 +574,97 @@ def get_mesowest_data(begin, end, station):
         key_name = element_cd + '_set_1'
 
         if key_name in observations:
         key_name = element_cd + '_set_1'
 
         if key_name in observations:

-            if observations[key_name][pos]:
-                remote_data[element_cd] = observations[key_name][pos]
+            # val is what will make it into the dataset, after
+            # conversions... it gets defined here because in certain
+            # cases we need to look at all of the data to calculate HN24
+            # or wind averages, but for the rest of the data, we only
+            # take the most recent
+            val = None
+
+            # loop through all observations for this key_name
+            # record relevant values for wind averaging or hn24, but
+            # otherwise only persist the data if it's the last datum in
+            # the set
+            for idx, _ in enumerate(observations[key_name]):
+                val = observations[key_name][idx]
+
+                # skip bunk vals
+                if val is None:
+                    continue

 
                 # mesowest by default provides wind_speed in m/s, but
                 # we specify 'english' units in the request; either way,
                 # we want mph
                 if element_cd in ('wind_speed', 'wind_gust'):
 
                 # mesowest by default provides wind_speed in m/s, but
                 # we specify 'english' units in the request; either way,
                 # we want mph
                 if element_cd in ('wind_speed', 'wind_gust'):

-                    remote_data[element_cd] = kn_to_mph(remote_data[element_cd])
-            else:
+                    val = kn_to_mph(val)
+
+                # mesowest provides HS in mm, not cm; we want cm
+                if element_cd == 'snow_depth' and station['units'] == 'metric':
+                    val = mm_to_cm(val)
+
+                # HN24 / wind_mode transformations, once the data has
+                # completed unit conversions
+                if station['wind_mode'] == "average":
+                    if element_cd == 'wind_speed' and val is not None:
+                        wind_speed_values.append(val)
+                    elif element_cd == 'wind_gust' and val is not None:
+                        wind_gust_speed_values.append(val)
+                    elif element_cd == 'wind_direction' and val is not None:
+                        wind_direction_values.append(val)
+
+                if element_cd == 'snow_depth':
+                    hn24_values.append(val)
+
+                # again, only persist this datum to the final data if
+                # it's from the most recent date
+                if idx == pos:
+                    remote_data[element_cd] = val
+
+            # ensure that the data is filled out
+            if not observations[key_name][pos]:

                 remote_data[element_cd] = None
         else:
             remote_data[element_cd] = None
 
                 remote_data[element_cd] = None
         else:
             remote_data[element_cd] = None
 

+    if len(hn24_values) > 0:
+        # instead of taking MAX - MIN, we want the first value (most
+        # distant) - the last value (most recent)
+        #
+        # if the result is positive, then we have HN24; if it's not,
+        # then we have settlement
+        #hn24 = max(hn24_values) - min(hn24_values)
+        hn24 = hn24_values[0] - hn24_values[len(hn24_values)-1]
+
+        if hn24 < 0.0:
+            # this case represents HS settlement
+            #
+            # TODO: determine if InfoEx supports auto-stations reporting
+            #       HS settlement values
+            hn24 = 0.0
+
+    if len(wind_speed_values) > 0:
+        wind_speed_avg = sum(wind_speed_values) / len(wind_speed_values) 
+
+    if len(wind_gust_speed_values) > 0:
+        wind_gust_speed_avg = sum(wind_gust_speed_values) / len(wind_gust_speed_values) 
+
+    if len(wind_direction_values) > 0:
+        wind_direction_avg = sum(wind_direction_values) / len(wind_direction_values) 
+
+    if hn24 is not None:
+        remote_data['hn24'] = hn24
+
+    # overwrite the following with the respective averages, if
+    # applicable
+    if wind_speed_avg is not None:
+        remote_data['wind_speed'] = wind_speed_avg
+
+    if wind_gust_speed_avg is not None:
+        remote_data['wind_gust'] = wind_gust_speed_avg
+
+    if wind_direction_avg is not None:
+        remote_data['wind_direction'] = wind_direction_avg
+

     return remote_data
 
 def switch_units_to_metric(data_map, mapping):
     return remote_data
 
 def switch_units_to_metric(data_map, mapping):


@@ -595,7 +734,7 @@ def setup_time_values(station):
     end_date = date_time - datetime.timedelta(minutes=date_time.minute % 60,
                                               seconds=date_time.second,
                                               microseconds=date_time.microsecond)
     end_date = date_time - datetime.timedelta(minutes=date_time.minute % 60,
                                               seconds=date_time.second,
                                               microseconds=date_time.microsecond)

-    begin_date = end_date - datetime.timedelta(hours=3)
+    begin_date = end_date - datetime.timedelta(hours=station['num_hrs_to_fetch'])

     return (begin_date, end_date)
 
 def f_to_c(f):
     return (begin_date, end_date)
 
 def f_to_c(f):


@@ -618,5 +757,9 @@ def kn_to_mph(kn):
     """convert knots to miles per hour"""
     return kn * 1.150779
 
     """convert knots to miles per hour"""
     return kn * 1.150779
 

+def mm_to_cm(mm):
+    """convert millimeters to centimetrs"""
+    return mm / 10.0
+

 if __name__ == "__main__":
     sys.exit(main())
 if __name__ == "__main__":
     sys.exit(main())