From 1d25e6aed39a7ecaefec05607dcff6abd60fe5d8 Mon Sep 17 00:00:00 2001 From: gjr80 Date: Tue, 28 Nov 2023 10:40:36 +1000 Subject: [PATCH] revised example WD import config file --- src/weewx_data/util/import/wd-example.conf | 196 +++++++++++++-------- 1 file changed, 119 insertions(+), 77 deletions(-) diff --git a/src/weewx_data/util/import/wd-example.conf b/src/weewx_data/util/import/wd-example.conf index 50fe0f27..8c3b26c7 100644 --- a/src/weewx_data/util/import/wd-example.conf +++ b/src/weewx_data/util/import/wd-example.conf @@ -46,6 +46,10 @@ source = WD # windGust # windSpeed # + # Note: The user may change the WeeWX field populated by a field from the + # WD data through use of a field map and/or field map extensions. + # Refer to the wee_import documentation. + # # The following WeeWX database fields will be populated from other # settings/config files: # interval @@ -55,7 +59,6 @@ source = WD # from the imported data provided the --calc-missing command line option is # used during import: # altimeter - # ET # pressure # rainRate # windchill @@ -220,84 +223,123 @@ source = WD # The default is True ignore_extreme_temp_hum = True - # Map WD log fields to WeeWX archive fields. Format is: + # Define a field map to source data fields to WeeWX archive fields. The map + # is defined under the [[FieldMap]] stanza and consists of one sub-stanza + # per WeeWX archive field being populated using the following format: # - # weewx_archive_field_name = wd_field_name + # [[[weewx_archive_field_name]]] + # source_field = cumulus_field_name + # unit = weewx_unit_name + # cumulative = True | False # - # where: - # weewx_archive_field_name - An observation name in the WeeWX database - # schema. - # wd_field_name - The name of a WD field from the CSV file. - # For example, - # outTemp = temperature - # would map the WD log field temperature to the archive field outTemp. + # Where + # 'weewx_archive_field_name' is a field in the in-use WeeWX archive table + # schema + # 'cumulus_field_name' is the name of a field in the Cumulus source data + # 'weewx_unit_name' is a WeeWX unit name e.g., 'degree_C' # - # Note that due to some issues with the field names used in some WD logs - # weeimport uses the following field names when reading WD log data: - # temperature - # humidity - # dewpoint - # barometer - # windspeed - # gustspeed - # direction - # rainlastmin - # heatindex - # radiation in lieu of 'Solar radation' and ''Solar ,radiat.' - # uv in lieu of 'UV' - # soilmoist in lieu of 'soil moist' - # soiltemp in lieu of 'soil temp' - # temp1 - # temp2 - # temp3 - # temp4 - # temp5 - # temp6 - # temp7 - # hum1 - # hum2 - # hum3 - # hum4 - # hum5 - # hum6 - # hum7 + # Each WeeWX archive field stanza supports the following options: + # 'source_field'. The name of the Weather Display field to be mapped to the + # WeeWX archive field. Mandatory. + # 'unit'. The WeeWX unit name of the units used by 'source_field'. + # Mandatory. + # 'cumulative'. Whether the source Weather Display field is a cumulative + # value or not (e.g., daily rainfall). Optional boolean value. Default is + # False. # - # WeeWX archive fields that do not exist in the logs to be imported may be - # omitted (it is usually safest to omit fields for which you know there is - # no data to import as otherwise you may end up with a value of 0 (or - # something else) in the WeeWX archive when the appropriate value is - # None/null). Any omitted fields that are derived (eg dewpoint) may be - # calculated during import using the equivalent of the WeeWX StdWXCalculate - # service through setting the calc-missing config option above. Note also - # that whilst there may be a mapping for a field and the WD log may contain - # valid data the only fields that will be saved to the WeeWX archive are - # those fields in the in-use schema. Refer to the 'Archive types' appendix - # and the 'Customizing the database' section of the Customization Guide. + # Further details of the Weather Display field map can be found in WeeWX + # Utilities guide under 'weectl import', 'Configuration options', 'WD', + # '[[FieldMap]]'. + # + # An example field map stanza is provided below. Once the units are + # adjusted this field map should suit most users but can be tailored to + # suit specific needs. [[FieldMap]] - outTemp = temperature - outHumidity = humidity - dewpoint = dewpoint - barometer = barometer - windSpeed = windspeed - gustSpeed = gustspeed - windDir = direction - rain = rainlastmin - heatindex = heatindex - radiation = radiation - UV = uv - soilMoist1 = soilmoist - soilTemp1 = soiltemp - extraTemp1 = temp1 - extraTemp2 = temp2 - extraTemp3 = temp3 - extraTemp4 = temp4 - extraTemp5 = temp5 - extraTemp6 = temp6 - extraTemp7 = temp7 - extraHumid1 = hum1 - extraHumid2 = hum2 - extraHumid3 = hum3 - extraHumid4 = hum4 - extraHumid5 = hum5 - extraHumid6 = hum6 - extraHumid7 = hum7 + [[[dateTime]]] + source_field = datetime + unit = unix_epoch + [[[outTemp]]] + source_field = temperature + unit = degree_C + [[[outHumidity]]] + source_field = humidity + unit = percent + [[[dewpoint]]] + source_field = dewpoint + unit = degree_C + [[[heatindex]]] + source_field = heatindex + unit = degree_C + [[[barometer]]] + source_field = barometer + unit = hPa + [[[windSpeed]]] + source = windspeed + unit = km_per_hour + [[[windDir]]] + source_field = direction + unit = degree_compass + [[[gustSpeed]]] + source = gustspeed + unit = km_per_hour + [[[rain]]] + source_field = rainlastmin + unit = mm + [[[radiation]]] + source_field = radiation + unit = watt_per_meter_squared + [[[UV]]] + source_field = uv + unit = uv_index + [[[ET]]] + source_field = dailyet + unit = mm + cumulative = True + [[[extraTemp1]]] + source_field = temp1 + unit = degree_C + [[[extraTemp2]]] + source_field = temp2 + unit = degree_C + [[[extraTemp3]]] + source_field = temp3 + unit = degree_C + [[[extraTemp4]]] + source_field = temp4 + unit = degree_C + [[[extraTemp5]]] + source_field = temp5 + unit = degree_C + [[[extraTemp6]]] + source_field = temp6 + unit = degree_C + [[[extraTemp7]]] + source_field = temp7 + unit = degree_C + [[[extraHumid1]]] + source_field = hum1 + unit = percent + [[[extraHumid2]]] + source_field = hum2 + unit = percent + [[[extraHumid3]]] + source_field = hum3 + unit = percent + [[[extraHumid4]]] + source_field = hum4 + unit = percent + [[[extraHumid5]]] + source_field = hum5 + unit = percent + [[[extraHumid6]]] + source_field = hum6 + unit = percent + [[[extraHumid7]]] + source_field = hum7 + unit = percent + [[[soilTemp1]]] + source_field = soiltemp + unit = degree_C + [[[soilMoist1]]] + source_field = soilmoist + unit = centibar