text: # coding: utf-8
  #
  #    Copyright (c) 2009-2021 Tom Keffer <tkeffer@gmail.com>
  #
  #    See the file LICENSE.txt for your rights.
  #
  """Utilities used by the setup and configure programs"""
  
  from __future__ import print_function
  from __future__ import with_statement
  from __future__ import absolute_import
  
  import errno
  import glob
  import os.path
  import shutil
  import sys
  import tempfile
  
  from six.moves import StringIO, input
  
  import configobj
  
  import weeutil.weeutil
  import weeutil.config
  from weeutil.weeutil import to_bool
  
  major_comment_block = ["", "##############################################################################", ""]
  
  DEFAULT_URL = 'http://acme.com'
  
  # ==============================================================================
  
  unit_systems = {
      'us': {'group_altitude': 'foot',
             'group_degree_day': 'degree_F_day',
             'group_distance': 'mile',
             'group_pressure': 'inHg',
             'group_rain': 'inch',
             'group_rainrate': 'inch_per_hour',
             'group_speed': 'mile_per_hour',
             'group_speed2': 'mile_per_hour2',
             'group_temperature': 'degree_F'},
  
      'metric': {'group_altitude': 'meter',
                 'group_degree_day': 'degree_C_day',
                 'group_distance': 'km',
                 'group_pressure': 'mbar',
                 'group_rain': 'cm',
                 'group_rainrate': 'cm_per_hour',
                 'group_speed': 'km_per_hour',
                 'group_speed2': 'km_per_hour2',
                 'group_temperature': 'degree_C'},
  
      'metricwx': {'group_altitude': 'meter',
                   'group_degree_day': 'degree_C_day',
                   'group_distance': 'km',
                   'group_pressure': 'mbar',
                   'group_rain': 'mm',
                   'group_rainrate': 'mm_per_hour',
                   'group_speed': 'meter_per_second',
                   'group_speed2': 'meter_per_second2',
                   'group_temperature': 'degree_C'}
  }
  
  
  class ExtensionError(IOError):
      """Errors when installing or uninstalling an extension"""
  
  
  class Logger(object):
      def __init__(self, verbosity=0):
          self.verbosity = verbosity
  
      def log(self, msg, level=0):
          if self.verbosity >= level:
              print("%s%s" % ('  ' * (level - 1), msg))
  
      def set_verbosity(self, verbosity):
          self.verbosity = verbosity
  
  
  # ==============================================================================
  #              Utilities that find and save ConfigObj objects
  # ==============================================================================
  
  DEFAULT_LOCATIONS = ['../..', '/etc/weewx', '/home/weewx']
  
  
  def find_file(file_path=None, args=None, locations=DEFAULT_LOCATIONS,
                file_name='weewx.conf'):
      """Find and return a path to a file, looking in "the usual places."
  
      General strategy:
  
      First, file_path is tried. If not found there, then the first element of
      args is tried.
  
      If those fail, try a path based on where the application is running.
  
      If that fails, then the list of directory locations is searched,
      looking for a file with file name file_name.
  
      If after all that, the file still cannot be found, then an IOError
      exception will be raised.
  
      Parameters:
  
      file_path: A candidate path to the file.
  
      args: command-line arguments. If the file cannot be found in file_path,
      then the first element in args will be tried.
  
      locations: A list of directories to be searched. If they do not
      start with a slash ('/'), then they will be treated as relative to
      this file (bin/weecfg/__init__.py).
      Default is ['../..', '/etc/weewx', '/home/weewx'].
  
      file_name: The name of the file to be found. This is used
      only if the directories must be searched. Default is 'weewx.conf'.
  
      returns: full path to the file
      """
  
      # Start by searching args (if available)
      if file_path is None and args:
          for i in range(len(args)):
              if not args[i].startswith('-'):
                  file_path = args[i]
                  del args[i]
                  break
  
      if file_path is None:
          for directory in locations:
              # If this is a relative path, then prepend with the
              # directory this file is in:
              if not directory.startswith('/'):
                  directory = os.path.join(os.path.dirname(__file__), directory)
              candidate = os.path.abspath(os.path.join(directory, file_name))
              if os.path.isfile(candidate):
                  return candidate
  
      if file_path is None:
          raise IOError("Unable to find file '%s'. Tried directories %s" %
                        (file_name, locations))
      elif not os.path.isfile(file_path):
          raise IOError("%s is not a file" % file_path)
  
      return file_path
  
  
  def read_config(config_path, args=None, locations=DEFAULT_LOCATIONS,
                  file_name='weewx.conf', interpolation='ConfigParser'):
      """Read the specified configuration file, return an instance of ConfigObj
      with the file contents. If no file is specified, look in the standard
      locations for weewx.conf. Returns the filename of the actual configuration
      file, as well as the ConfigObj.
  
      config_path: configuration filename
  
      args: command-line arguments
  
      return: path-to-file, instance-of-ConfigObj
  
      Raises:
  
      SyntaxError: If there is a syntax error in the file
  
      IOError: If the file cannot be found
      """
      # Find and open the config file:
      config_path = find_file(config_path, args,
                              locations=locations, file_name=file_name)
      try:
          # Now open it up and parse it.
          config_dict = configobj.ConfigObj(config_path,
                                            interpolation=interpolation,
                                            file_error=True,
                                            encoding='utf-8',
                                            default_encoding='utf-8')
      except configobj.ConfigObjError as e:
          # Add on the path of the offending file, then reraise.
          e.msg += ' File %s' % config_path
          raise
  
      return config_path, config_dict
  
  
  def save_with_backup(config_dict, config_path):
      return save(config_dict, config_path, backup=True)
  
  
  def save(config_dict, config_path, backup=False):
      """Save the config file, backing up as necessary."""
  
      # Check to see if the file exists and we are supposed to make backup:
      if os.path.exists(config_path) and backup:
  
          # Yes. We'll have to back it up.
          backup_path = weeutil.weeutil.move_with_timestamp(config_path)
  
          # Now we can save the file. Get a temporary file:
          with tempfile.NamedTemporaryFile() as tmpfile:
              # Write the configuration dictionary to it:
              config_dict.write(tmpfile)
              tmpfile.flush()
  
              # Now move the temporary file into the proper place:
              shutil.copyfile(tmpfile.name, config_path)
  
      else:
  
          # No existing file or no backup required. Just write.
          with open(config_path, 'wb') as fd:
              config_dict.write(fd)
          backup_path = None
  
      return backup_path
  
  
  # ==============================================================================
  #              Utilities that modify ConfigObj objects
  # ==============================================================================
  
  def modify_config(config_dict, stn_info, logger, debug=False):
      """If a driver has a configuration editor, then use that to insert the
      stanza for the driver in the config_dict.  If there is no configuration
      editor, then inject a generic configuration, i.e., just the driver name
      with a single 'driver' element that points to the driver file.
      """
      driver_editor = None
      driver_name = None
      driver_version = None
  
      # Get the driver editor, name, and version:
      driver = stn_info.get('driver')
      if driver:
          try:
              # Look up driver info:
              driver_editor, driver_name, driver_version = load_driver_editor(driver)
          except Exception as e:
              sys.exit("Driver %s failed to load: %s" % (driver, e))
          stn_info['station_type'] = driver_name
          if debug:
              logger.log('Using %s version %s (%s)'
                         % (driver_name, driver_version, driver), level=1)
  
      # Get a driver stanza, if possible
      stanza = None
      if driver_name is not None:
          if driver_editor is not None:
              orig_stanza_text = None
  
              # if a previous stanza exists for this driver, grab it
              if driver_name in config_dict:
                  orig_stanza = configobj.ConfigObj(interpolation=False)
                  orig_stanza[driver_name] = config_dict[driver_name]
                  orig_stanza_text = '\n'.join(orig_stanza.write())
  
              # let the driver process the stanza or give us a new one
              stanza_text = driver_editor.get_conf(orig_stanza_text)
              stanza = configobj.ConfigObj(stanza_text.splitlines())
  
              # let the driver modify other parts of the configuration
              driver_editor.modify_config(config_dict)
          else:
              stanza = configobj.ConfigObj(interpolation=False)
              if driver_name in config_dict:
                  stanza[driver_name] = config_dict[driver_name]
              else:
                  stanza[driver_name] = {}
  
      # If we have a stanza, inject it into the configuration dictionary
      if stanza is not None and driver_name is not None:
          # Ensure that the driver field matches the path to the actual driver
          stanza[driver_name]['driver'] = driver
          # Insert the stanza in the configuration dictionary:
          config_dict[driver_name] = stanza[driver_name]
          # Add a major comment deliminator:
          config_dict.comments[driver_name] = major_comment_block
          # If we have a [Station] section, move the new stanza to just after it
          if 'Station' in config_dict:
              reorder_sections(config_dict, driver_name, 'Station', after=True)
              # make the stanza the station type
              config_dict['Station']['station_type'] = driver_name
  
      # Apply any overrides from the stn_info
      if stn_info:
          # Update driver stanza with any overrides from stn_info
          if driver_name is not None and driver_name in stn_info:
              for k in stn_info[driver_name]:
                  config_dict[driver_name][k] = stn_info[driver_name][k]
          # Update station information with stn_info overrides
          for p in ['location', 'latitude', 'longitude', 'altitude']:
              if p in stn_info:
                  if debug:
                      logger.log("Using %s for %s" % (stn_info[p], p), level=2)
                  config_dict['Station'][p] = stn_info[p]
          # Update units display with any stn_info overrides
          if 'units' in stn_info and 'StdReport' in config_dict:
              update_units(config_dict, stn_info['units'], logger, debug)
  
          if 'register_this_station' in stn_info \
                  and 'StdRESTful' in config_dict \
                  and 'StationRegistry' in config_dict['StdRESTful']:
              config_dict['StdRESTful']['StationRegistry']['register_this_station'] \
                  = stn_info['register_this_station']
  
          if 'station_url' in stn_info and 'Station' in config_dict:
              if 'station_url' in config_dict['Station']:
                  config_dict['Station']['station_url'] = stn_info['station_url']
              else:
                  inject_station_url(config_dict, stn_info['station_url'])
  
  
  def inject_station_url(config_dict, url):
      """Inject the option station_url into the [Station] section"""
  
      if 'station_url' in config_dict['Station']:
          # Already injected. Done.
          return
  
      # Isolate just the [Station] section. This simplifies what follows
      station_dict = config_dict['Station']
  
      # First search for any existing comments that mention 'station_url'
      for scalar in station_dict.scalars:
          for ilist, comment in enumerate(station_dict.comments[scalar]):
              if comment.find('station_url') != -1:
                  # This deletes the (up to) three lines related to station_url that ships
                  # with the standard distribution
                  del station_dict.comments[scalar][ilist]
                  if ilist and station_dict.comments[scalar][ilist - 1].find('specify an URL') != -1:
                      del station_dict.comments[scalar][ilist - 1]
                  if ilist > 1 and station_dict.comments[scalar][ilist - 2].strip() == '':
                      del station_dict.comments[scalar][ilist - 2]
  
      # Add the new station_url, plus comments
      station_dict['station_url'] = url
      station_dict.comments['station_url'] \
          = ['', '    # If you have a website, you may specify an URL']
  
      # Reorder to match the canonical ordering.
      reorder_scalars(station_dict.scalars, 'station_url', 'rain_year_start')
  
  # ==============================================================================
  #              Utilities that update and merge ConfigObj objects
  # ==============================================================================
  
  
  def update_and_merge(config_dict, template_dict):
      """First update a configuration file, then merge it with the distribution template"""
  
      update_config(config_dict)
      merge_config(config_dict, template_dict)
  
  
  def update_config(config_dict):
      """Update a (possibly old) configuration dictionary to the latest format.
  
      Raises exception of type ValueError if it cannot be done.
      """
  
      major, minor = get_version_info(config_dict)
  
      # I don't know how to merge older, V1.X configuration files, only
      # newer V2.X ones.
      if major == '1':
          raise ValueError("Cannot update version V%s.%s. Too old" % (major, minor))
  
      update_to_v25(config_dict)
  
      update_to_v26(config_dict)
  
      update_to_v30(config_dict)
  
      update_to_v32(config_dict)
  
      update_to_v36(config_dict)
  
      update_to_v39(config_dict)
  
      update_to_v40(config_dict)
  
      update_to_v42(config_dict)
  
      update_to_v43(config_dict)
  
  
  def merge_config(config_dict, template_dict):
      """Merge the template (distribution) dictionary into the user's dictionary.
  
      config_dict: An existing, older configuration dictionary.
  
      template_dict: A newer dictionary supplied by the installer.
      """
  
      # All we need to do is update the version number:
      config_dict['version'] = template_dict['version']
  
  
  def update_to_v25(config_dict):
      """Major changes for V2.5:
  
      - Option webpath is now station_url
      - Drivers are now in their own package
      - Introduction of the station registry
  
      """
      major, minor = get_version_info(config_dict)
  
      if major + minor >= '205':
          return
  
      try:
          # webpath is now station_url
          webpath = config_dict['Station'].get('webpath')
          station_url = config_dict['Station'].get('station_url')
          if webpath is not None and station_url is None:
              config_dict['Station']['station_url'] = webpath
          config_dict['Station'].pop('webpath', None)
      except KeyError:
          pass
  
      # Drivers are now in their own Python package. Change the names.
  
      # --- Davis Vantage series ---
      try:
          if config_dict['Vantage']['driver'].strip() == 'weewx.VantagePro':
              config_dict['Vantage']['driver'] = 'weewx.drivers.vantage'
      except KeyError:
          pass
  
      # --- Oregon Scientific WMR100 ---
  
      # The section name has changed from WMR-USB to WMR100
      if 'WMR-USB' in config_dict:
          if 'WMR100' in config_dict:
              sys.exit("\n*** Configuration file has both a 'WMR-USB' "
                       "section and a 'WMR100' section. Aborting ***\n\n")
          config_dict.rename('WMR-USB', 'WMR100')
      # If necessary, reflect the section name in the station type:
      try:
          if config_dict['Station']['station_type'].strip() == 'WMR-USB':
              config_dict['Station']['station_type'] = 'WMR100'
      except KeyError:
          pass
      # Finally, the name of the driver has been changed
      try:
          if config_dict['WMR100']['driver'].strip() == 'weewx.wmrx':
              config_dict['WMR100']['driver'] = 'weewx.drivers.wmr100'
      except KeyError:
          pass
  
      # --- Oregon Scientific WMR9x8 series ---
  
      # The section name has changed from WMR-918 to WMR9x8
      if 'WMR-918' in config_dict:
          if 'WMR9x8' in config_dict:
              sys.exit("\n*** Configuration file has both a 'WMR-918' "
                       "section and a 'WMR9x8' section. Aborting ***\n\n")
          config_dict.rename('WMR-918', 'WMR9x8')
      # If necessary, reflect the section name in the station type:
      try:
          if config_dict['Station']['station_type'].strip() == 'WMR-918':
              config_dict['Station']['station_type'] = 'WMR9x8'
      except KeyError:
          pass
      # Finally, the name of the driver has been changed
      try:
          if config_dict['WMR9x8']['driver'].strip() == 'weewx.WMR918':
              config_dict['WMR9x8']['driver'] = 'weewx.drivers.wmr9x8'
      except KeyError:
          pass
  
      # --- Fine Offset instruments ---
  
      try:
          if config_dict['FineOffsetUSB']['driver'].strip() == 'weewx.fousb':
              config_dict['FineOffsetUSB']['driver'] = 'weewx.drivers.fousb'
      except KeyError:
          pass
  
      # --- The weewx Simulator ---
  
      try:
          if config_dict['Simulator']['driver'].strip() == 'weewx.simulator':
              config_dict['Simulator']['driver'] = 'weewx.drivers.simulator'
      except KeyError:
          pass
  
      if 'StdArchive' in config_dict:
          # Option stats_types is no longer used. Get rid of it.
          config_dict['StdArchive'].pop('stats_types', None)
  
      try:
          # V2.5 saw the introduction of the station registry:
          if 'StationRegistry' not in config_dict['StdRESTful']:
              stnreg_dict = configobj.ConfigObj(StringIO("""[StdRESTful]
  
          [[StationRegistry]]
              # Uncomment the following line to register this weather station.
              #register_this_station = True
  
              # Specify a station URL, otherwise the station_url from [Station]
              # will be used.
              #station_url = http://example.com/weather/
  
              # Specify a description of the station, otherwise the location from
              # [Station] will be used.
              #description = The greatest station on earth
  
              driver = weewx.restful.StationRegistry
  
      """), encoding='utf-8')
              config_dict.merge(stnreg_dict)
      except KeyError:
          pass
  
      config_dict['version'] = '2.5.0'
  
  
  def update_to_v26(config_dict):
      """Update a configuration diction to V2.6.
  
      Major changes:
  
      - Addition of "model" option for WMR100, WMR200, and WMR9x8
      - New option METRICWX
      - Engine service list now broken up into separate sublists
      - Introduction of 'log_success' and 'log_failure' options
      - Introduction of rapidfire
      - Support of uploaders for WOW and AWEKAS
      - CWOP option 'interval' changed to 'post_interval'
      - CWOP option 'server' changed to 'server_list' (and is not in default weewx.conf)
      """
  
      major, minor = get_version_info(config_dict)
  
      if major + minor >= '206':
          return
  
      try:
          if 'model' not in config_dict['WMR100']:
              config_dict['WMR100']['model'] = 'WMR100'
              config_dict['WMR100'].comments['model'] = \
                  ["", "    # The station model, e.g., WMR100, WMR100N, WMRS200"]
      except KeyError:
          pass
  
      try:
          if 'model' not in config_dict['WMR200']:
              config_dict['WMR200']['model'] = 'WMR200'
              config_dict['WMR200'].comments['model'] = \
                  ["", "    # The station model, e.g., WMR200, WMR200A, Radio Shack W200"]
      except KeyError:
          pass
  
      try:
          if 'model' not in config_dict['WMR9x8']:
              config_dict['WMR9x8']['model'] = 'WMR968'
              config_dict['WMR9x8'].comments['model'] = \
                  ["", "    # The station model, e.g., WMR918, Radio Shack 63-1016"]
      except KeyError:
          pass
  
      # Option METRICWX was introduced. Include it in the inline comment
      try:
          config_dict['StdConvert'].inline_comments['target_unit'] = "# Options are 'US', 'METRICWX', or 'METRIC'"
      except KeyError:
          pass
  
      # New default values for inHumidity, rain, and windSpeed Quality Controls
      try:
          if 'inHumidity' not in config_dict['StdQC']['MinMax']:
              config_dict['StdQC']['MinMax']['inHumidity'] = [0, 100]
          if 'rain' not in config_dict['StdQC']['MinMax']:
              config_dict['StdQC']['MinMax']['rain'] = [0, 60, "inch"]
          if 'windSpeed' not in config_dict['StdQC']['MinMax']:
              config_dict['StdQC']['MinMax']['windSpeed'] = [0, 120, "mile_per_hour"]
          if 'inTemp' not in config_dict['StdQC']['MinMax']:
              config_dict['StdQC']['MinMax']['inTemp'] = [10, 20, "degree_F"]
      except KeyError:
          pass
  
      service_map_v2 = {'weewx.wxengine.StdTimeSynch': 'prep_services',
                        'weewx.wxengine.StdConvert': 'process_services',
                        'weewx.wxengine.StdCalibrate': 'process_services',
                        'weewx.wxengine.StdQC': 'process_services',
                        'weewx.wxengine.StdArchive': 'archive_services',
                        'weewx.wxengine.StdPrint': 'report_services',
                        'weewx.wxengine.StdReport': 'report_services'}
  
      # See if the engine configuration section has the old-style "service_list":
      if 'Engines' in config_dict and 'service_list' in config_dict['Engines']['WxEngine']:
          # It does. Break it up into five, smaller lists. If a service
          # does not appear in the dictionary "service_map_v2", meaning we
          # do not know what it is, then stick it in the last group we
          # have seen. This should get its position about right.
          last_group = 'prep_services'
  
          # Set up a bunch of empty groups in the right order. Option 'data_services' was actually introduced
          # in v3.0, but it can be included without harm here.
          for group in ['prep_services', 'data_services', 'process_services', 'archive_services',
                        'restful_services', 'report_services']:
              config_dict['Engines']['WxEngine'][group] = list()
  
          # Add a helpful comment
          config_dict['Engines']['WxEngine'].comments['prep_services'] = \
              ['', ' # The list of services the main weewx engine should run:']
  
          # Now map the old service names to the right group
          for _svc_name in config_dict['Engines']['WxEngine']['service_list']:
              svc_name = _svc_name.strip()
              # Skip the no longer needed StdRESTful service:
              if svc_name == 'weewx.wxengine.StdRESTful':
                  continue
              # Do we know about this service?
              if svc_name in service_map_v2:
                  # Yes. Get which group it belongs to, and put it there
                  group = service_map_v2[svc_name]
                  config_dict['Engines']['WxEngine'][group].append(svc_name)
                  last_group = group
              else:
                  # No. Put it in the last group.
                  config_dict['Engines']['WxEngine'][last_group].append(svc_name)
  
          # Now add the restful services, using the old driver name to help us
          for section in config_dict['StdRESTful'].sections:
              svc = config_dict['StdRESTful'][section]['driver']
              # weewx.restful has changed to weewx.restx
              if svc.startswith('weewx.restful'):
                  svc = 'weewx.restx.Std' + section
              # awekas is in weewx.restx since 2.6
              if svc.endswith('AWEKAS'):
                  svc = 'weewx.restx.AWEKAS'
              config_dict['Engines']['WxEngine']['restful_services'].append(svc)
  
          # Depending on how old a version the user has, the station registry
          # may have to be included:
          if 'weewx.restx.StdStationRegistry' not in config_dict['Engines']['WxEngine']['restful_services']:
              config_dict['Engines']['WxEngine']['restful_services'].append('weewx.restx.StdStationRegistry')
  
          # Get rid of the no longer needed service_list:
          config_dict['Engines']['WxEngine'].pop('service_list', None)
  
      # V2.6 introduced "log_success" and "log_failure" options.
      # The "driver" option was removed.
      for section in config_dict['StdRESTful']:
          # Save comments before popping driver
          comments = config_dict['StdRESTful'][section].comments.get('driver', [])
          if 'log_success' not in config_dict['StdRESTful'][section]:
              config_dict['StdRESTful'][section]['log_success'] = True
          if 'log_failure' not in config_dict['StdRESTful'][section]:
              config_dict['StdRESTful'][section]['log_failure'] = True
          config_dict['StdRESTful'][section].comments['log_success'] = comments
          config_dict['StdRESTful'][section].pop('driver', None)
  
      # Option 'rapidfire' was new:
      try:
          if 'rapidfire' not in config_dict['StdRESTful']['Wunderground']:
              config_dict['StdRESTful']['Wunderground']['rapidfire'] = False
              config_dict['StdRESTful']['Wunderground'].comments['rapidfire'] = \
                  ['',
                   '        # Set the following to True to have weewx use the WU "Rapidfire"',
                   '        # protocol']
      except KeyError:
          pass
  
      # Support for the WOW uploader was introduced
      try:
          if 'WOW' not in config_dict['StdRESTful']:
              config_dict.merge(configobj.ConfigObj(StringIO("""[StdRESTful]
  
              [[WOW]]
                  # This section is for configuring posts to WOW
  
                  # If you wish to do this, uncomment the following station and password
                  # lines and fill them with your station and password:
                  #station = your WOW station ID
                  #password = your WOW password
  
                  log_success = True
                  log_failure = True
  
          """), encoding='utf-8'))
              config_dict['StdRESTful'].comments['WOW'] = ['']
      except KeyError:
          pass
  
      # Support for the AWEKAS uploader was introduced
      try:
          if 'AWEKAS' not in config_dict['StdRESTful']:
              config_dict.merge(configobj.ConfigObj(StringIO("""[StdRESTful]
  
              [[AWEKAS]]
                  # This section is for configuring posts to AWEKAS
  
                  # If you wish to do this, uncomment the following username and password
                  # lines and fill them with your username and password:
                  #username = your AWEKAS username
                  #password = your AWEKAS password
  
                  log_success = True
                  log_failure = True
  
          """), encoding='utf-8'))
              config_dict['StdRESTful'].comments['AWEKAS'] = ['']
      except KeyError:
          pass
  
      # The CWOP option "interval" has changed to "post_interval"
      try:
          if 'interval' in config_dict['StdRESTful']['CWOP']:
              comment = config_dict['StdRESTful']['CWOP'].comments['interval']
              config_dict['StdRESTful']['CWOP']['post_interval'] = \
                  config_dict['StdRESTful']['CWOP']['interval']
              config_dict['StdRESTful']['CWOP'].pop('interval')
              config_dict['StdRESTful']['CWOP'].comments['post_interval'] = comment
      except KeyError:
          pass
  
      try:
          if 'server' in config_dict['StdRESTful']['CWOP']:
              # Save the old comments, as they are useful for setting up CWOP
              comments = [c for c in config_dict['StdRESTful']['CWOP'].comments.get('server') if 'Comma' not in c]
              # Option "server" has become "server_list". It is also no longer
              # included in the default weewx.conf, so just pop it.
              config_dict['StdRESTful']['CWOP'].pop('server', None)
              # Put the saved comments in front of the first scalar.
              key = config_dict['StdRESTful']['CWOP'].scalars[0]
              config_dict['StdRESTful']['CWOP'].comments[key] = comments
      except KeyError:
          pass
  
      config_dict['version'] = '2.6.0'
  
  
  def update_to_v30(config_dict):
      """Update a configuration file to V3.0
  
       - Introduction of the new database structure
       - Introduction of StdWXCalculate
      """
  
      major, minor = get_version_info(config_dict)
  
      if major + minor >= '300':
          return
  
      old_database = None
  
      if 'StdReport' in config_dict:
          # The key "data_binding" is now used instead of these:
          config_dict['StdReport'].pop('archive_database', None)
          config_dict['StdReport'].pop('stats_database', None)
          if 'data_binding' not in config_dict['StdReport']:
              config_dict['StdReport']['data_binding'] = 'wx_binding'
              config_dict['StdReport'].comments['data_binding'] = \
                  ['', "    # The database binding indicates which data should be used in reports"]
  
      if 'Databases' in config_dict:
          # The stats database no longer exists. Remove it from the [Databases]
          # section:
          config_dict['Databases'].pop('stats_sqlite', None)
          config_dict['Databases'].pop('stats_mysql', None)
          # The key "database" changed to "database_name"
          for stanza in config_dict['Databases']:
              if 'database' in config_dict['Databases'][stanza]:
                  config_dict['Databases'][stanza].rename('database',
                                                          'database_name')
  
      if 'StdArchive' in config_dict:
          # Save the old database, if it exists
          old_database = config_dict['StdArchive'].pop('archive_database', None)
          # Get rid of the no longer needed options
          config_dict['StdArchive'].pop('stats_database', None)
          config_dict['StdArchive'].pop('archive_schema', None)
          config_dict['StdArchive'].pop('stats_schema', None)
          # Add the data_binding option
          if 'data_binding' not in config_dict['StdArchive']:
              config_dict['StdArchive']['data_binding'] = 'wx_binding'
              config_dict['StdArchive'].comments['data_binding'] = \
                  ['', "    # The data binding to be used"]
  
      if 'DataBindings' not in config_dict:
          # Insert a [DataBindings] section. First create it
          c = configobj.ConfigObj(StringIO("""[DataBindings]
              # This section binds a data store to a database
  
              [[wx_binding]]
                  # The database must match one of the sections in [Databases]
                  database = archive_sqlite
                  # The name of the table within the database
                  table_name = archive
                  # The manager handles aggregation of data for historical summaries
                  manager = weewx.manager.DaySummaryManager
                  # The schema defines the structure of the database.
                  # It is *only* used when the database is created.
                  schema = schemas.wview.schema
  
          """), encoding='utf-8')
          # Now merge it in:
          config_dict.merge(c)
          # For some reason, ConfigObj strips any leading comments. Put them back:
          config_dict.comments['DataBindings'] = major_comment_block
          # Move the new section to just before [Databases]
          reorder_sections(config_dict, 'DataBindings', 'Databases')
          # No comments between the [DataBindings] and [Databases] sections:
          config_dict.comments['Databases'] = [""]
          config_dict.inline_comments['Databases'] = []
  
          # If there was an old database, add it in the new, correct spot:
          if old_database:
              try:
                  config_dict['DataBindings']['wx_binding']['database'] = old_database
              except KeyError:
                  pass
  
      # StdWXCalculate is new
      if 'StdWXCalculate' not in config_dict:
          c = configobj.ConfigObj(StringIO("""[StdWXCalculate]
      # Derived quantities are calculated by this service.  Possible values are:
      #  hardware        - use the value provided by hardware
      #  software        - use the value calculated by weewx
      #  prefer_hardware - use value provide by hardware if available,
      #                      otherwise use value calculated by weewx
  
      pressure = prefer_hardware
      barometer = prefer_hardware
      altimeter = prefer_hardware
      windchill = prefer_hardware
      heatindex = prefer_hardware
      dewpoint = prefer_hardware
      inDewpoint = prefer_hardware
      rainRate = prefer_hardware"""), encoding='utf-8')
          # Now merge it in:
          config_dict.merge(c)
          # For some reason, ConfigObj strips any leading comments. Put them back:
          config_dict.comments['StdWXCalculate'] = major_comment_block
          # Move the new section to just before [StdArchive]
          reorder_sections(config_dict, 'StdWXCalculate', 'StdArchive')
  
      # Section ['Engines'] got renamed to ['Engine']
      if 'Engine' not in config_dict and 'Engines' in config_dict:
          config_dict.rename('Engines', 'Engine')
          # Subsection [['WxEngine']] got renamed to [['Services']]
          if 'WxEngine' in config_dict['Engine']:
              config_dict['Engine'].rename('WxEngine', 'Services')
  
              # Finally, module "wxengine" got renamed to "engine". Go through
              # each of the service lists, making the change
              for list_name in config_dict['Engine']['Services']:
                  service_list = config_dict['Engine']['Services'][list_name]
                  # If service_list is not already a list (it could be just a
                  # single name), then make it a list:
                  if not isinstance(service_list, (tuple, list)):
                      service_list = [service_list]
                  config_dict['Engine']['Services'][list_name] = \
                      [this_item.replace('wxengine', 'engine') for this_item in service_list]
          try:
              # Finally, make sure the new StdWXCalculate service is in the list:
              if 'weewx.wxservices.StdWXCalculate' not in config_dict['Engine']['Services']['process_services']:
                  config_dict['Engine']['Services']['process_services'].append('weewx.wxservices.StdWXCalculate')
          except KeyError:
              pass
  
      config_dict['version'] = '3.0.0'
  
  
  def update_to_v32(config_dict):
      """Update a configuration file to V3.2
  
      - Introduction of section [DatabaseTypes]
      - New option in [Databases] points to DatabaseType
      """
  
      major, minor = get_version_info(config_dict)
  
      if major + minor >= '302':
          return
  
      # For interpolation to work, it's critical that WEEWX_ROOT not end
      # with a trailing slash ('/'). Convert it to the normative form:
      config_dict['WEEWX_ROOT'] = os.path.normpath(config_dict['WEEWX_ROOT'])
  
      # Add a default database-specific top-level stanzas if necessary
      if 'DatabaseTypes' not in config_dict:
          # Do SQLite first. Start with a sanity check:
          try:
              assert (config_dict['Databases']['archive_sqlite']['driver'] == 'weedb.sqlite')
          except KeyError:
              pass
          # Set the default [[SQLite]] section. Turn off interpolation first, so the
          # symbol for WEEWX_ROOT does not get lost.
          save, config_dict.interpolation = config_dict.interpolation, False
          # The section must be built step by step so we get the order of the entries correct
          config_dict['DatabaseTypes'] = {}
          config_dict['DatabaseTypes']['SQLite'] = {}
          config_dict['DatabaseTypes']['SQLite']['driver'] = 'weedb.sqlite'
          config_dict['DatabaseTypes']['SQLite']['SQLITE_ROOT'] = '%(WEEWX_ROOT)s/archive'
          config_dict['DatabaseTypes'].comments['SQLite'] = \
              ['', '    # Defaults for SQLite databases']
          config_dict['DatabaseTypes']['SQLite'].comments['SQLITE_ROOT'] \
              = "        # Directory in which the database files are located"
          config_dict.interpolation = save
          try:
              root = config_dict['Databases']['archive_sqlite']['root']
              database_name = config_dict['Databases']['archive_sqlite']['database_name']
              fullpath = os.path.join(root, database_name)
              dirname = os.path.dirname(fullpath)
              # By testing to see if they end up resolving to the same thing,
              # we can keep the interpolation used to specify SQLITE_ROOT above.
              if dirname != config_dict['DatabaseTypes']['SQLite']['SQLITE_ROOT']:
                  config_dict['DatabaseTypes']['SQLite']['SQLITE_ROOT'] = dirname
              config_dict['DatabaseTypes']['SQLite'].comments['SQLITE_ROOT'] = \
                  ['        # Directory in which the database files are located']
              config_dict['Databases']['archive_sqlite']['database_name'] = os.path.basename(fullpath)
              config_dict['Databases']['archive_sqlite']['database_type'] = 'SQLite'
              config_dict['Databases']['archive_sqlite'].pop('root', None)
              config_dict['Databases']['archive_sqlite'].pop('driver', None)
          except KeyError:
              pass
  
          # Now do MySQL. Start with a sanity check:
          try:
              assert (config_dict['Databases']['archive_mysql']['driver'] == 'weedb.mysql')
          except KeyError:
              pass
          config_dict['DatabaseTypes']['MySQL'] = {}
          config_dict['DatabaseTypes'].comments['MySQL'] = ['', '    # Defaults for MySQL databases']
          try:
              config_dict['DatabaseTypes']['MySQL']['host'] = \
                  config_dict['Databases']['archive_mysql'].get('host', 'localhost')
              config_dict['DatabaseTypes']['MySQL']['user'] = \
                  config_dict['Databases']['archive_mysql'].get('user', 'weewx')
              config_dict['DatabaseTypes']['MySQL']['password'] = \
                  config_dict['Databases']['archive_mysql'].get('password', 'weewx')
              config_dict['DatabaseTypes']['MySQL']['driver'] = 'weedb.mysql'
              config_dict['DatabaseTypes']['MySQL'].comments['host'] = [
                  "        # The host where the database is located"]
              config_dict['DatabaseTypes']['MySQL'].comments['user'] = [
                  "        # The user name for logging into the host"]
              config_dict['DatabaseTypes']['MySQL'].comments['password'] = [
                  "        # The password for the user name"]
              config_dict['Databases']['archive_mysql'].pop('host', None)
              config_dict['Databases']['archive_mysql'].pop('user', None)
              config_dict['Databases']['archive_mysql'].pop('password', None)
              config_dict['Databases']['archive_mysql'].pop('driver', None)
              config_dict['Databases']['archive_mysql']['database_type'] = 'MySQL'
              config_dict['Databases'].comments['archive_mysql'] = ['']
          except KeyError:
              pass
  
          # Move the new section to just before [Engine]
          reorder_sections(config_dict, 'DatabaseTypes', 'Engine')
          # Add a major comment deliminator:
          config_dict.comments['DatabaseTypes'] = \
              major_comment_block + \
              ['#   This section defines defaults for the different types of databases', '']
  
      # Version 3.2 introduces the 'enable' keyword for RESTful protocols. Set
      # it appropriately
      def set_enable(c, service, keyword):
          # Check to see whether this config file has the service listed
          try:
              c['StdRESTful'][service]
          except KeyError:
              # It does not. Nothing to do.
              return
  
          # Now check to see whether it already has the option 'enable':
          if 'enable' in c['StdRESTful'][service]:
              # It does. No need to proceed
              return
  
          # The option 'enable' is not present. Add it,
          # and set based on whether the keyword is present:
          if keyword in c['StdRESTful'][service]:
              c['StdRESTful'][service]['enable'] = 'true'
          else:
              c['StdRESTful'][service]['enable'] = 'false'
          # Add a comment for it
          c['StdRESTful'][service].comments['enable'] = ['', '    # Set to true to enable this uploader']
  
      set_enable(config_dict, 'AWEKAS', 'username')
      set_enable(config_dict, 'CWOP', 'station')
      set_enable(config_dict, 'PWSweather', 'station')
      set_enable(config_dict, 'WOW', 'station')
      set_enable(config_dict, 'Wunderground', 'station')
  
      config_dict['version'] = '3.2.0'
  
  
  def update_to_v36(config_dict):
      """Update a configuration file to V3.6
  
      - New subsection [[Calculations]]
      """
  
      major, minor = get_version_info(config_dict)
  
      if major + minor >= '306':
          return
  
      # Perform the following only if the dictionary has a StdWXCalculate section
      if 'StdWXCalculate' in config_dict:
          # No need to update if it already has a 'Calculations' section:
          if 'Calculations' not in config_dict['StdWXCalculate']:
              # Save the comment attached to the first scalar
              try:
                  first = config_dict['StdWXCalculate'].scalars[0]
                  comment = config_dict['StdWXCalculate'].comments[first]
                  config_dict['StdWXCalculate'].comments[first] = ''
              except IndexError:
                  comment = """    # Derived quantities are calculated by this service. Possible values are:
      #  hardware        - use the value provided by hardware
      #  software        - use the value calculated by weewx
      #  prefer_hardware - use value provide by hardware if available,
      #                      otherwise use value calculated by weewx"""
              # Create a new 'Calculations' section:
              config_dict['StdWXCalculate']['Calculations'] = {}
              # Now transfer over the options. Make a copy of them first: we will be
              # deleting some of them.
              scalars = list(config_dict['StdWXCalculate'].scalars)
              for scalar in scalars:
                  # These scalars don't get moved:
                  if not scalar in ['ignore_zero_wind', 'rain_period',
                                    'et_period', 'wind_height', 'atc',
                                    'nfac', 'max_delta_12h']:
                      config_dict['StdWXCalculate']['Calculations'][scalar] = config_dict['StdWXCalculate'][scalar]
                      config_dict['StdWXCalculate'].pop(scalar)
              # Insert the old comment at the top of the new stanza:
              try:
                  first = config_dict['StdWXCalculate']['Calculations'].scalars[0]
                  config_dict['StdWXCalculate']['Calculations'].comments[first] = comment
              except IndexError:
                  pass
  
      config_dict['version'] = '3.6.0'
  
  
  def update_to_v39(config_dict):
      """Update a configuration file to V3.9
  
      - New top-level options log_success and log_failure
      - New subsections [[SeasonsReport]], [[SmartphoneReport]], and [[MobileReport]]
      - New section [StdReport][[Defaults]]
      """
  
      major, minor = get_version_info(config_dict)
  
      if major + minor >= '309':
          return
  
      # Add top-level log_success and log_failure if missing
      if 'log_success' not in config_dict:
          config_dict['log_success'] = True
          config_dict.comments['log_success'] = ['', '# Whether to log successful operations']
          reorder_scalars(config_dict.scalars, 'log_success', 'socket_timeout')
      if 'log_failure' not in config_dict:
          config_dict['log_failure'] = True
          config_dict.comments['log_failure'] = ['', '# Whether to log unsuccessful operations']
          reorder_scalars(config_dict.scalars, 'log_failure', 'socket_timeout')
  
      if 'StdReport' in config_dict:
  
          #
          # The logic below will put the subsections in the following order:
          #
          #   [[StandardReport]]
          #   [[SeasonsReport]]
          #   [[SmartphoneReport]]
          #   [[MobileReport]]
          #   [[FTP]]
          #   [[RSYNC]
          #   [[Defaults]]
          #
          #  NB: For an upgrade, we want StandardReport first, because that's
          #  what the user is already using.
          #
  
          # Work around a ConfigObj limitation that can cause comments to be dropped.
          # Save the original comment, then restore it later.
          std_report_comment = config_dict.comments['StdReport']
  
          if 'Defaults' not in config_dict['StdReport']:
              defaults_dict = configobj.ConfigObj(StringIO(DEFAULTS), encoding='utf-8')
              weeutil.config.merge_config(config_dict, defaults_dict)
              reorder_sections(config_dict['StdReport'], 'Defaults', 'RSYNC', after=True)
  
          if 'SeasonsReport' not in config_dict['StdReport']:
              seasons_options_dict = configobj.ConfigObj(StringIO(SEASONS_REPORT), encoding='utf-8')
              weeutil.config.merge_config(config_dict, seasons_options_dict)
              reorder_sections(config_dict['StdReport'], 'SeasonsReport', 'FTP')
  
          if 'SmartphoneReport' not in config_dict['StdReport']:
              smartphone_options_dict = configobj.ConfigObj(StringIO(SMARTPHONE_REPORT),
                                                            encoding='utf-8')
              weeutil.config.merge_config(config_dict, smartphone_options_dict)
              reorder_sections(config_dict['StdReport'], 'SmartphoneReport', 'FTP')
  
          if 'MobileReport' not in config_dict['StdReport']:
              mobile_options_dict = configobj.ConfigObj(StringIO(MOBILE_REPORT), encoding='utf-8')
              weeutil.config.merge_config(config_dict, mobile_options_dict)
              reorder_sections(config_dict['StdReport'], 'MobileReport', 'FTP')
  
          if 'StandardReport' in config_dict['StdReport'] \
                  and 'enable' not in config_dict['StdReport']['StandardReport']:
              config_dict['StdReport']['StandardReport']['enable'] = True
  
      # Put the comment for [StdReport] back in
      config_dict.comments['StdReport'] = std_report_comment
  
      # Remove all comments before each report section
      for report in config_dict['StdReport'].sections:
          if report == 'Defaults':
              continue
          config_dict['StdReport'].comments[report] = ['']
  
      # Special comment for the first report section:
      first_section_name = config_dict['StdReport'].sections[0]
      config_dict['StdReport'].comments[first_section_name] \
          = ['',
             '####',
             '',
             '# Each of the following subsections defines a report that will be run.',
             '# See the customizing guide to change the units, plot types and line',
             '# colors, modify the fonts, display additional sensor data, and other',
             '# customizations. Many of those changes can be made here by overriding',
             '# parameters, or by modifying templates within the skin itself.',
             ''
             ]
  
      config_dict['version'] = '3.9.0'
  
  
  def update_to_v40(config_dict):
      """Update a configuration file to V4.0
  
      - Add option loop_request for Vantage users.
      - Fix problems with DegreeDays and Trend in weewx.conf
      - Add new option growing_base
      - Add new option WU api_key
      - Add options to [StdWXCalculate] that were formerly defaults
      """
  
      # No need to check for the version of weewx for these changes.
  
      if 'Vantage' in config_dict \
              and 'loop_request' not in config_dict['Vantage']:
          config_dict['Vantage']['loop_request'] = 1
          config_dict['Vantage'].comments['loop_request'] = \
              ['', 'The type of LOOP packet to request: 1 = LOOP1; 2 = LOOP2; 3 = both']
          reorder_scalars(config_dict['Vantage'].scalars, 'loop_request', 'iss_id')
  
      if 'StdReport' in config_dict \
              and 'Defaults' in config_dict['StdReport'] \
              and 'Units' in config_dict['StdReport']['Defaults']:
  
          # Both the DegreeDays and Trend subsections accidentally ended up
          # in the wrong section
          for key in ['DegreeDays', 'Trend']:
  
              # Proceed only if the key has not already been moved, and exists in the incorrect spot:
              if key not in config_dict['StdReport']['Defaults']['Units'] \
                      and 'Ordinates' in config_dict['StdReport']['Defaults']['Units'] \
                      and key in config_dict['StdReport']['Defaults']['Units']['Ordinates']:
                  # Save the old comment
                  old_comment = config_dict['StdReport']['Defaults']['Units']['Ordinates'].comments[key]
  
                  # Shallow copy the sub-section
                  config_dict['StdReport']['Defaults']['Units'][key] = \
                      config_dict['StdReport']['Defaults']['Units']['Ordinates'][key]
                  # Delete it in from its old location
                  del config_dict['StdReport']['Defaults']['Units']['Ordinates'][key]
  
                  # Unfortunately, ConfigObj can't fix these things when doing a shallow copy:
                  config_dict['StdReport']['Defaults']['Units'][key].depth = \
                      config_dict['StdReport']['Defaults']['Units'].depth + 1
                  config_dict['StdReport']['Defaults']['Units'][key].parent = \
                      config_dict['StdReport']['Defaults']['Units']
                  config_dict['StdReport']['Defaults']['Units'].comments[key] = old_comment
  
      # Now add the option "growing_base" if it hasn't already been added:
      if 'StdReport' in config_dict \
              and 'Defaults' in config_dict['StdReport'] \
              and 'Units' in config_dict['StdReport']['Defaults'] \
              and 'DegreeDays' in config_dict['StdReport']['Defaults']['Units'] \
              and 'growing_base' not in config_dict['StdReport']['Defaults']['Units']['DegreeDays']:
          config_dict['StdReport']['Defaults']['Units']['DegreeDays']['growing_base'] = [50.0, 'degree_F']
          config_dict['StdReport']['Defaults']['Units']['DegreeDays'].comments['growing_base'] = \
              ["Base temperature for growing days, with unit:"]
  
      # Add the WU API key if it hasn't already been added
      if 'StdRESTful' in config_dict \
              and 'Wunderground' in config_dict['StdRESTful'] \
              and 'api_key' not in config_dict['StdRESTful']['Wunderground']:
          config_dict['StdRESTful']['Wunderground']['api_key'] = 'replace_me'
          config_dict['StdRESTful']['Wunderground'].comments['api_key'] = \
              ["", "If you plan on using wunderfixer, set the following", "to your API key:"]
  
      # The following types were never listed in weewx.conf and, instead, depended on defaults.
      if 'StdWXCalculate' in config_dict \
              and 'Calculations' in config_dict['StdWXCalculate']:
          config_dict['StdWXCalculate']['Calculations'].setdefault('maxSolarRad', 'prefer_hardware')
          config_dict['StdWXCalculate']['Calculations'].setdefault('cloudbase', 'prefer_hardware')
          config_dict['StdWXCalculate']['Calculations'].setdefault('humidex', 'prefer_hardware')
          config_dict['StdWXCalculate']['Calculations'].setdefault('appTemp', 'prefer_hardware')
          config_dict['StdWXCalculate']['Calculations'].setdefault('ET', 'prefer_hardware')
          config_dict['StdWXCalculate']['Calculations'].setdefault('windrun', 'prefer_hardware')
  
      # This section will inject a [Logging] section. Leave it commented out for now,
      # until we gain more experience with it.
  
      # if 'Logging' not in config_dict:
      #     logging_dict = configobj.ConfigObj(StringIO(weeutil.logger.LOGGING_STR), interpolation=False)
      #
      #     # Delete some not needed (and dangerous) entries
      #     try:
      #         del logging_dict['Logging']['version']
      #         del logging_dict['Logging']['disable_existing_loggers']
      #     except KeyError:
      #         pass
      #
      #     config_dict.merge(logging_dict)
      #
      #     # Move the new section to just before [Engine]
      #     reorder_sections(config_dict, 'Logging', 'Engine')
      #     config_dict.comments['Logging'] = \
      #         major_comment_block + \
      #         ['#   This section customizes logging', '']
  
      # Make sure the version number is at least 4.0
      major, minor = get_version_info(config_dict)
  
      if major + minor < '400':
          config_dict['version'] = '4.0.0'
  
  
  def update_to_v42(config_dict):
      """Update a configuration file to V4.2
  
      - Add new engine service group xtype_services
      """
  
      if 'Engine' in config_dict and 'Services' in config_dict['Engine']:
          # If it's not there already, inject 'xtype_services'
          if 'xtype_services' not in config_dict['Engine']['Services']:
              config_dict['Engine']['Services']['xtype_services'] = \
                  ['weewx.wxxtypes.StdWXXTypes',
                   'weewx.wxxtypes.StdPressureCooker',
                   'weewx.wxxtypes.StdRainRater',
                   'weewx.wxxtypes.StdDelta']
  
          # V4.2.0 neglected to include StdDelta. If necessary, add it:
          if 'weewx.wxxtypes.StdDelta' not in config_dict['Engine']['Services']['xtype_services']:
              config_dict['Engine']['Services']['xtype_services'].append('weewx.wxxtypes.StdDelta')
  
          # Make sure xtype_services are located just before the 'archive_services'
          reorder_scalars(config_dict['Engine']['Services'].scalars,
                          'xtype_services',
                          'archive_services')
          config_dict['Engine']['Services'].comments['prep_services'] = []
          config_dict['Engine']['Services'].comments['xtype_services'] = []
          config_dict['Engine'].comments['Services'] = ['The following section specifies which '
                                                        'services should be run and in what order.']
      config_dict['version'] = '4.2.0'
  
  
  def update_to_v43(config_dict):
      """Update a configuration file to V4.3
  
      - Set [StdReport] / log_failure to True
      """
      if 'StdReport' in config_dict and 'log_failure' in config_dict['StdReport']:
          config_dict['StdReport']['log_failure'] = True
  
      config_dict['version'] = '4.3.0'
  
  
  def update_units(config_dict, unit_system_name, logger=None, debug=False):
      """Update [StdReport][Defaults] with the desired unit system"""
  
      if unit_system_name == 'mixed':
          return
      elif unit_system_name is not None:
          try:
              config_dict['StdReport']['Defaults']['Units']['Groups'].update(unit_systems[unit_system_name])
          except KeyError:
              # We are missing the [StdReport] / [[Defaults]] / [[[Units]]] / [[[[Groups]]]] section.
              # Create a section, then merge it into the ConfigObj.
              unit_dict = configobj.ConfigObj(StringIO(UNIT_DEFAULTS), encoding='utf-8')
              weeutil.config.merge_config(config_dict, unit_dict)
  
  
  # ==============================================================================
  #              Utilities that extract from ConfigObj objects
  # ==============================================================================
  
  def get_version_info(config_dict):
      # Get the version number. If it does not appear at all, then
      # assume a very old version:
      config_version = config_dict.get('version') or '1.0.0'
  
      # Updates only care about the major and minor numbers
      parts = config_version.split('.')
      major = parts[0]
      minor = parts[1]
  
      # Take care of the collation problem when comparing things like
      # version '1.9' to '1.10' by prepending a '0' to the former:
      if len(minor) < 2:
          minor = '0' + minor
  
      return major, minor
  
  
  def get_station_info(config_dict):
      """Extract station info from config dictionary.
  
      Returns:
          A station_info structure. If a key is missing in the structure, that means no
          information is available about it.
      """
      stn_info = dict()
      if config_dict:
          if 'Station' in config_dict:
              if 'location' in config_dict['Station']:
                  stn_info['location'] \
                      = weeutil.weeutil.list_as_string(config_dict['Station']['location'])
              if 'latitude' in config_dict['Station']:
                  stn_info['latitude'] = config_dict['Station']['latitude']
              if 'longitude' in config_dict['Station']:
                  stn_info['longitude'] = config_dict['Station']['longitude']
              if 'altitude' in config_dict['Station']:
                  stn_info['altitude'] = config_dict['Station']['altitude']
              if 'station_type' in config_dict['Station']:
                  stn_info['station_type'] = config_dict['Station']['station_type']
                  if stn_info['station_type'] in config_dict:
                      stn_info['driver'] = config_dict[stn_info['station_type']]['driver']
  
              # Try to figure out what unit system the user is using.
              try:
                  # First look for a [Defaults] section.
                  stn_info['units'] = get_unit_info(config_dict['StdReport']['Defaults'])
              except KeyError:
                  # If that didn't work, look for an override in the [[StandardReport]] section.
                  try:
                      stn_info['units'] = get_unit_info(config_dict['StdReport']['StandardReport'])
                  except KeyError:
                      pass
          try:
              stn_info['register_this_station'] \
                  = config_dict['StdRESTful']['StationRegistry']['register_this_station']
          except KeyError:
              pass
          try:
              stn_info['station_url'] = config_dict['Station']['station_url']
          except KeyError:
              pass
  
      return stn_info
  
  
  def get_unit_info(test_dict):
      """Intuit what unit system the reports are in.
  
      Returns:
          'us':       US Customary system
          'metric':   METRIC system
          'metricwx': METRICWX system
          'mixed':    Mixed unit system
          None:       There is no information about the unit system.
      """
      try:
          group_dict = test_dict['Units']['Groups']
      except KeyError:
          return None
  
      # Test all unit systems ('us', 'metric', 'metricwx'):
      for unit_system in unit_systems:
          # For this unit system, make sure there is an exact match
          if all(group_dict[group] == unit_systems[unit_system][group]
                 for group in unit_systems[unit_system]):
              return unit_system
      # No exact match. In in a mix of unit systems
      return 'mixed'
  
  
  # ==============================================================================
  #                Utilities that manipulate ConfigObj objects
  # ==============================================================================
  
  def reorder_sections(config_dict, src, dst, after=False):
      """Move the section with key src to just before (after=False) or after
      (after=True) the section with key dst. """
      bump = 1 if after else 0
      # We need both keys to procede:
      if src not in config_dict.sections or dst not in config_dict.sections:
          return
      # If index raises an exception, we want to fail hard.
      # Find the source section (the one we intend to move):
      src_idx = config_dict.sections.index(src)
      # Save the key
      src_key = config_dict.sections[src_idx]
      # Remove it
      config_dict.sections.pop(src_idx)
      # Find the destination
      dst_idx = config_dict.sections.index(dst)
      # Now reorder the attribute 'sections', putting src just before dst:
      config_dict.sections = config_dict.sections[:dst_idx + bump] + [src_key] + \
                             config_dict.sections[dst_idx + bump:]
  
  
  def reorder_scalars(scalars, src, dst):
      """Reorder so the src item is just before the dst item"""
      try:
          src_index = scalars.index(src)
      except ValueError:
          return
      scalars.pop(src_index)
      # If the destination cannot be found, but the src object at the end
      try:
          dst_index = scalars.index(dst)
      except ValueError:
          dst_index = len(scalars)
  
      scalars.insert(dst_index, src)
  
  
  # def reorder(name_list, ref_list):
  #     """Reorder the names in name_list, according to a reference list."""
  #     result = []
  #     # Use the ordering in ref_list, to reassemble the name list:
  #     for name in ref_list:
  #         # These always come at the end
  #         if name in ['FTP', 'RSYNC']:
  #             continue
  #         if name in name_list:
  #             result.append(name)
  #     # Finally, add these, so they are at the very end
  #     for name in ref_list:
  #         if name in name_list and name in ['FTP', 'RSYNC']:
  #             result.append(name)
  #
  #     return result
  #
  
  def remove_and_prune(a_dict, b_dict):
      """Remove fields from a_dict that are present in b_dict"""
      for k in b_dict:
          if isinstance(b_dict[k], dict):
              if k in a_dict and type(a_dict[k]) is configobj.Section:
                  remove_and_prune(a_dict[k], b_dict[k])
                  if not a_dict[k].sections:
                      a_dict.pop(k)
          elif k in a_dict:
              a_dict.pop(k)
  
  
  def prepend_path(a_dict, label, value):
      """Prepend the value to every instance of the label in dict a_dict"""
      for k in a_dict:
          if isinstance(a_dict[k], dict):
              prepend_path(a_dict[k], label, value)
          elif k == label:
              a_dict[k] = os.path.join(value, a_dict[k])
  
  
  # def replace_string(a_dict, label, value):
  #    for k in a_dict:
  #        if isinstance(a_dict[k], dict):
  #            replace_string(a_dict[k], label, value)
  #        else:
  #            a_dict[k] = a_dict[k].replace(label, value)
  
  # ==============================================================================
  #                Utilities that work on drivers
  # ==============================================================================
  
  def get_all_driver_infos():
      # first look in the drivers directory
      infos = get_driver_infos()
      # then add any drivers in the user directory
      infos.update(get_driver_infos('user'))
      return infos
  
  
  def get_driver_infos(driver_pkg_name='weewx.drivers', excludes=['__init__.py']):
      """Scan the drivers folder, extracting information about each available
      driver. Return as a dictionary, keyed by the driver module name.
  
      Valid drivers must be importable, and must have attribute "DRIVER_NAME"
      defined.
      """
  
      __import__(driver_pkg_name)
      driver_package = sys.modules[driver_pkg_name]
      driver_pkg_directory = os.path.dirname(os.path.abspath(driver_package.__file__))
      driver_list = [os.path.basename(f) for f in glob.glob(os.path.join(driver_pkg_directory, "*.py"))]
  
      driver_info_dict = {}
      for filename in driver_list:
          if filename in excludes:
              continue
  
          # Get the driver module name. This will be something like
          # 'weewx.drivers.fousb'
          driver_module_name = os.path.splitext("%s.%s" % (driver_pkg_name,
                                                           filename))[0]
  
          try:
              # Try importing the module
              __import__(driver_module_name)
              driver_module = sys.modules[driver_module_name]
  
              # A valid driver will define the attribute "DRIVER_NAME"
              if hasattr(driver_module, 'DRIVER_NAME'):
                  # A driver might define the attribute DRIVER_VERSION
                  driver_module_version = driver_module.DRIVER_VERSION \
                      if hasattr(driver_module, 'DRIVER_VERSION') else '?'
                  # Create an entry for it, keyed by the driver module name
                  driver_info_dict[driver_module_name] = {
                      'module_name': driver_module_name,
                      'driver_name': driver_module.DRIVER_NAME,
                      'version': driver_module_version,
                      'status': ''}
          except ImportError as e:
              # If the import fails, report it in the status
              driver_info_dict[driver_module_name] = {
                  'module_name': driver_module_name,
                  'driver_name': '?',
                  'version': '?',
                  'status': e}
          except Exception as e:
              # Ignore anything else.  This might be a python file that is not
              # a driver, a python file with errors, or who knows what.
              pass
  
      return driver_info_dict
  
  
  def print_drivers():
      """Get information about all the available drivers, then print it out."""
      driver_info_dict = get_all_driver_infos()
      keys = sorted(driver_info_dict)
      print("%-25s%-15s%-9s%-25s" % ("Module name", "Driver name", "Version", "Status"))
      for d in keys:
          print("  %(module_name)-25s%(driver_name)-15s%(version)-9s%(status)-25s" % driver_info_dict[d])
  
  
  def load_driver_editor(driver_module_name):
      """Load the configuration editor from the driver file
  
      driver_module_name: A string holding the driver name.
                          E.g., 'weewx.drivers.fousb'
      """
      __import__(driver_module_name)
      driver_module = sys.modules[driver_module_name]
      editor = None
      driver_name = None
      driver_version = 'undefined'
      if hasattr(driver_module, 'confeditor_loader'):
          loader_function = getattr(driver_module, 'confeditor_loader')
          editor = loader_function()
      if hasattr(driver_module, 'DRIVER_NAME'):
          driver_name = driver_module.DRIVER_NAME
      if hasattr(driver_module, 'DRIVER_VERSION'):
          driver_version = driver_module.DRIVER_VERSION
      return editor, driver_name, driver_version
  
  
  # ==============================================================================
  #                Utilities that seek info from the command line
  # ==============================================================================
  
  def prompt_for_info(location=None, latitude='90.000', longitude='0.000',
                      altitude=['0', 'meter'], units='metric',
                      register_this_station='false',
                      station_url=DEFAULT_URL, **kwargs):
      stn_info = {}
      #
      #  Description
      #
      print("Enter a brief description of the station, such as its location.  For example:")
      print("Santa's Workshop, North Pole")
      stn_info['location'] = prompt_with_options("description", location)
  
      #
      #  Altitude
      #
      print("\nSpecify altitude, with units 'foot' or 'meter'.  For example:")
      print("35, foot")
      print("12, meter")
      msg = "altitude [%s]: " % weeutil.weeutil.list_as_string(altitude) if altitude else "altitude: "
      alt = None
      while alt is None:
          ans = input(msg).strip()
          if ans:
              parts = ans.split(',')
              if len(parts) == 2:
                  try:
                      # Test whether the first token can be converted into a
                      # number. If not, an exception will be raised.
                      float(parts[0])
                      if parts[1].strip() in ['foot', 'meter']:
                          alt = [parts[0].strip(), parts[1].strip()]
                  except (ValueError, TypeError):
                      pass
          elif altitude:
              alt = altitude
  
          if not alt:
              print("Unrecognized response. Try again.")
      stn_info['altitude'] = alt
  
      #
      # Latitude & Longitude
      #
      print("\nSpecify latitude in decimal degrees, negative for south.")
      stn_info['latitude'] = prompt_with_limits("latitude", latitude, -90, 90)
      print("Specify longitude in decimal degrees, negative for west.")
      stn_info['longitude'] = prompt_with_limits("longitude", longitude, -180, 180)
  
      #
      # Include in station registry?
      #
      default = 'y' if to_bool(register_this_station) else 'n'
      print("\nYou can register your station on weewx.com, where it will be included")
      print("in a map. You will need a unique URL to identify your station (such as a")
      print("website, or WeatherUnderground link).")
      registry = prompt_with_options("Include station in the station registry (y/n)?",
                                     default,
                                     ['y', 'n'])
      if registry.lower() == 'y':
          stn_info['register_this_station'] = 'true'
          while True:
              station_url = prompt_with_options("Unique URL:", station_url)
              if station_url == DEFAULT_URL:
                  print("Unique please!")
              else:
                  stn_info['station_url'] = station_url
                  break
      else:
          stn_info['register_this_station'] = 'false'
  
      #
      # Display units. Accept only 'us' or 'metric', where 'metric'
      # is a synonym for 'metricwx'.
      #
      options = ['us', 'metric']
      if units == 'mixed':
          options += [units]
      print("\nIndicate the preferred units for display: %s" % options)
      default = units if units != 'metricwx' else 'metric'
      uni = prompt_with_options("units", default, options)
      if uni == 'metric':
          uni = 'metricwx'
      stn_info['units'] = uni
  
      return stn_info
  
  
  def prompt_for_driver(dflt_driver=None):
      """Get the information about each driver, return as a dictionary."""
      if dflt_driver is None:
          dflt_driver = 'weewx.drivers.simulator'
      infos = get_all_driver_infos()
      keys = sorted(infos)
      dflt_idx = None
      print("\nInstalled drivers include:")
      for i, d in enumerate(keys):
          print(" %2d) %-15s %-25s %s" % (i, infos[d].get('driver_name', '?'),
                                          "(%s)" % d, infos[d].get('status', '')))
          if dflt_driver == d:
              dflt_idx = i
      msg = "choose a driver [%d]: " % dflt_idx if dflt_idx is not None else "choose a driver: "
      idx = 0
      ans = None
      while ans is None:
          ans = input(msg).strip()
          if not ans:
              ans = dflt_idx
          try:
              idx = int(ans)
              if not 0 <= idx < len(keys):
                  ans = None
          except (ValueError, TypeError):
              ans = None
      return keys[idx]
  
  
  def prompt_for_driver_settings(driver, config_dict):
      """Let the driver prompt for any required settings.  If the driver does
      not define a method for prompting, return an empty dictionary."""
      settings = dict()
      try:
          __import__(driver)
          driver_module = sys.modules[driver]
          loader_function = getattr(driver_module, 'confeditor_loader')
          editor = loader_function()
          editor.existing_options = config_dict.get(driver_module.DRIVER_NAME, {})
          settings[driver_module.DRIVER_NAME] = editor.prompt_for_settings()
      except AttributeError:
          pass
      return settings
  
  
  def prompt_with_options(prompt, default=None, options=None):
      """Ask the user for an input with an optional default value.
  
      prompt: A string to be used for a prompt.
  
      default: A default value. If the user simply hits <enter>, this
      is the value returned. Optional.
  
      options: A list of possible choices. The returned value must be in
      this list. Optional."""
  
      msg = "%s [%s]: " % (prompt, default) if default is not None else "%s: " % prompt
      value = None
      while value is None:
          value = input(msg).strip()
          if value:
              if options and value not in options:
                  value = None
          elif default is not None:
              value = default
  
      return value
  
  
  def prompt_with_limits(prompt, default=None, low_limit=None, high_limit=None):
      """Ask the user for an input with an optional default value. The
      returned value must lie between optional upper and lower bounds.
  
      prompt: A string to be used for a prompt.
  
      default: A default value. If the user simply hits <enter>, this
      is the value returned. Optional.
  
      low_limit: The value must be equal to or greater than this value.
      Optional.
  
      high_limit: The value must be less than or equal to this value.
      Optional.
      """
      msg = "%s [%s]: " % (prompt, default) if default is not None else "%s: " % prompt
      value = None
      while value is None:
          value = input(msg).strip()
          if value:
              try:
                  v = float(value)
                  if (low_limit is not None and v < low_limit) or \
                          (high_limit is not None and v > high_limit):
                      value = None
              except (ValueError, TypeError):
                  value = None
          elif default is not None:
              value = default
  
      return value
  
  
  # ==============================================================================
  #            Miscellaneous utilities
  # ==============================================================================
  
  def extract_roots(config_path, config_dict, bin_root):
      """Get the location of the various root directories used by weewx."""
  
      root_dict = {'WEEWX_ROOT': config_dict['WEEWX_ROOT'],
                   'CONFIG_ROOT': os.path.dirname(config_path)}
      # If bin_root has not been defined, then figure out where it is using
      # the location of this file:
      if bin_root:
          root_dict['BIN_ROOT'] = bin_root
      else:
          root_dict['BIN_ROOT'] = os.path.abspath(os.path.join(
              os.path.dirname(__file__), '..'))
      # The user subdirectory:
      root_dict['USER_ROOT'] = os.path.join(root_dict['BIN_ROOT'], 'user')
      # The extensions directory is in the user directory:
      root_dict['EXT_ROOT'] = os.path.join(root_dict['USER_ROOT'], 'installer')
      # Add SKIN_ROOT if it can be found:
      try:
          root_dict['SKIN_ROOT'] = os.path.abspath(os.path.join(
              root_dict['WEEWX_ROOT'],
              config_dict['StdReport']['SKIN_ROOT']))
      except KeyError:
          pass
  
      return root_dict
  
  
  def extract_tar(filename, target_dir, logger=None):
      """Extract files from a tar archive into a given directory
  
      Returns: A list of the extracted files
      """
      logger = logger or Logger()
      import tarfile
      logger.log("Extracting from tar archive %s" % filename, level=1)
      tar_archive = None
      try:
          tar_archive = tarfile.open(filename, mode='r')
          tar_archive.extractall(target_dir)
          member_names = [os.path.normpath(x.name) for x in tar_archive.getmembers()]
          return member_names
      finally:
          if tar_archive is not None:
              tar_archive.close()
  
  
  def extract_zip(filename, target_dir, logger=None):
      """Extract files from a zip archive into the specified directory.
  
      Returns: a list of the extracted files
      """
      logger = logger or Logger()
      import zipfile
      logger.log("Extracting from zip archive %s" % filename, level=1)
  
      zip_archive = zipfile.ZipFile(filename)
  
      try:
          member_names = zip_archive.namelist()
  
          # manually extract files since extractall is only in python 2.6+
          #        zip_archive.extractall(target_dir)
          for f in member_names:
              if f.endswith('/'):
                  dst = "%s/%s" % (target_dir, f)
                  mkdir_p(dst)
          for f in member_names:
              if not f.endswith('/'):
                  path = "%s/%s" % (target_dir, f)
                  with open(path, 'wb') as dest_file:
                      dest_file.write(zip_archive.read(f))
          return member_names
      finally:
          zip_archive.close()
  
  
  def mkdir_p(path):
      """equivalent to 'mkdir -p'"""
      try:
          os.makedirs(path)
      except OSError as e:
          if e.errno == errno.EEXIST and os.path.isdir(path):
              pass
          else:
              raise
  
  
  def get_extension_installer(extension_installer_dir):
      """Get the installer in the given extension installer subdirectory"""
      old_path = sys.path
      try:
          # Inject the location of the installer directory into the path
          sys.path.insert(0, extension_installer_dir)
          try:
              # Now I can import the extension's 'install' module:
              __import__('install')
          except ImportError:
              raise ExtensionError("Cannot find 'install' module in %s" % extension_installer_dir)
          install_module = sys.modules['install']
          loader = getattr(install_module, 'loader')
          # Get rid of the module:
          sys.modules.pop('install', None)
          installer = loader()
      finally:
          # Restore the path
          sys.path = old_path
  
      return (install_module.__file__, installer)
  
  
  # ==============================================================================
  #            Various config sections
  # ==============================================================================
  
  
  SEASONS_REPORT = """[StdReport]
  
      [[SeasonsReport]]
          # The SeasonsReport uses the 'Seasons' skin, which contains the
          # images, templates and plots for the report.
          skin = Seasons
          enable = false"""
  
  SMARTPHONE_REPORT = """[StdReport]
  
      [[SmartphoneReport]]
          # The SmartphoneReport uses the 'Smartphone' skin, and the images and
          # files are placed in a dedicated subdirectory.
          skin = Smartphone
          enable = false
          HTML_ROOT = public_html/smartphone"""
  
  MOBILE_REPORT = """[StdReport]
  
      [[MobileReport]]
          # The MobileReport uses the 'Mobile' skin, and the images and files
          # are placed in a dedicated subdirectory.
          skin = Mobile
          enable = false
          HTML_ROOT = public_html/mobile"""
  
  UNIT_DEFAULTS = """[StdReport]
  
      ####
  
      # Various options for customizing your reports.
  
      [[Defaults]]
  
          # The following section determines the selection and formatting of units.
          [[[Units]]]
  
              # The following section sets what unit to use for each unit group.
              # NB: The unit is always in the singular. I.e., 'mile_per_hour',
              # NOT 'miles_per_hour'
              [[[[Groups]]]]
  
                  group_altitude     = foot                 # Options are 'foot' or 'meter'
                  group_degree_day   = degree_F_day         # Options are 'degree_F_day' or 'degree_C_day'
                  group_distance     = mile                 # Options are 'mile' or 'km'
                  group_pressure     = inHg                 # Options are 'inHg', 'mmHg', 'mbar', or 'hPa'
                  group_rain         = inch                 # Options are 'inch', 'cm', or 'mm'
                  group_rainrate     = inch_per_hour        # Options are 'inch_per_hour', 'cm_per_hour', or 'mm_per_hour'
                  group_speed        = mile_per_hour        # Options are 'mile_per_hour', 'km_per_hour', 'knot', or 'meter_per_second'
                  group_speed2       = mile_per_hour2       # Options are 'mile_per_hour2', 'km_per_hour2', 'knot2', or 'meter_per_second2'
                  group_temperature  = degree_F             # Options are 'degree_F' or 'degree_C'
  """
  
  DEFAULTS = UNIT_DEFAULTS + """
  
              # The following section sets the formatting for each type of unit.
              [[[[StringFormats]]]]
  
                  centibar           = %.0f
                  cm                 = %.2f
                  cm_per_hour        = %.2f
                  degree_C           = %.1f
                  degree_F           = %.1f
                  degree_compass     = %.0f
                  foot               = %.0f
                  hPa                = %.1f
                  hour               = %.1f
                  inHg               = %.3f
                  inch               = %.2f
                  inch_per_hour      = %.2f
                  km_per_hour        = %.0f
                  km_per_hour2       = %.1f
                  knot               = %.0f
                  knot2              = %.1f
                  mbar               = %.1f
                  meter              = %.0f
                  meter_per_second   = %.1f
                  meter_per_second2  = %.1f
                  mile_per_hour      = %.0f
                  mile_per_hour2     = %.1f
                  mm                 = %.1f
                  mmHg               = %.1f
                  mm_per_hour        = %.1f
                  percent            = %.0f
                  second             = %.0f
                  uv_index           = %.1f
                  volt               = %.1f
                  watt_per_meter_squared = %.0f
                  NONE               = "   N/A"
  
              # The following section sets the label to be used for each type of unit
              [[[[Labels]]]]
  
                  day               = " day",    " days"
                  hour              = " hour",   " hours"
                  minute            = " minute", " minutes"
                  second            = " second", " seconds"
                  NONE              = ""
  
              # The following section sets the format to be used for each time scale.
              # The values below will work in every locale, but they may not look
              # particularly attractive. See the Customization Guide for alternatives.
              [[[[TimeFormats]]]]
  
                  hour       = %H:%M
                  day        = %X
                  week       = %X (%A)
                  month      = %x %X
                  year       = %x %X
                  rainyear   = %x %X
                  current    = %x %X
                  ephem_day  = %X
                  ephem_year = %x %X
  
              [[[[Ordinates]]]]
  
                  # Ordinal directions. The last one should be for no wind direction
                  directions = N, NNE, NE, ENE, E, ESE, SE, SSE, S, SSW, SW, WSW, W, WNW, NW, NNW, N/A
  
              # The following section sets the base temperatures used for the
              #  calculation of heating and cooling degree-days.
              [[[[[DegreeDays]]]]]
  
                  # Base temperature for heating days, with unit:
                  heating_base = 65, degree_F
                  # Base temperature for cooling days, with unit:
                  cooling_base = 65, degree_F
  
              # A trend takes a difference across a time period. The following
              # section sets the time period, and how big an error is allowed to
              # still be counted as the start or end of a period.
              [[[[[Trend]]]]]
  
                  time_delta = 10800  # 3 hours
                  time_grace = 300    # 5 minutes
  
          # The labels to be used for each observation type
          [[[Labels]]]
  
              # Set to hemisphere abbreviations suitable for your location:
              hemispheres = N, S, E, W
  
              # Formats to be used for latitude whole degrees, longitude whole
              # degrees, and minutes:
              latlon_formats = "%02d", "%03d", "%05.2f"
  
              # Generic labels, keyed by an observation type.
              [[[[Generic]]]]
                  barometer      = Barometer
                  dewpoint       = Dew Point
                  ET             = ET
                  heatindex      = Heat Index
                  inHumidity     = Inside Humidity
                  inTemp         = Inside Temperature
                  outHumidity    = Humidity
                  outTemp        = Outside Temperature
                  radiation      = Radiation
                  rain           = Rain
                  rainRate       = Rain Rate
                  UV             = UV Index
                  windDir        = Wind Direction
                  windGust       = Gust Speed
                  windGustDir    = Gust Direction
                  windSpeed      = Wind Speed
                  windchill      = Wind Chill
                  windgustvec    = Gust Vector
                  windvec        = Wind Vector
                  extraTemp1     = Temperature1
                  extraTemp2     = Temperature2
                  extraTemp3     = Temperature3
  
                  # Sensor status indicators
  
                  rxCheckPercent       = Signal Quality
                  txBatteryStatus      = Transmitter Battery
                  windBatteryStatus    = Wind Battery
                  rainBatteryStatus    = Rain Battery
                  outTempBatteryStatus = Outside Temperature Battery
                  inTempBatteryStatus  = Inside Temperature Battery
                  consBatteryVoltage   = Console Battery
                  heatingVoltage       = Heating Battery
                  supplyVoltage        = Supply Voltage
                  referenceVoltage     = Reference Voltage
  
          [[[Almanac]]]
  
              # The labels to be used for the phases of the moon:
              moon_phases = New, Waxing crescent, First quarter, Waxing gibbous, Full, Waning gibbous, Last quarter, Waning crescent
  """
  