A few fixes for custom providers
[infoex-autowx.git] / README.md
index ed40451a082c6054c4ace04b2d96fa036e120fc6..c9fc57646876096a96c95a3c025cbcaa6a973195 100644 (file)
--- a/README.md
+++ b/README.md
@@ -82,11 +82,11 @@ options.
 `token = # MesoWest API token -- only applies when type is mesowest #`  
 `station_id = # the NRCS/MesoWest identifier for a particular station #`  
 `desired_data = # a comma-delimited list of fields you're interested in #`  
-`units = # either english or metric -- only applies when type is mesowest #`  
+`units = # either english, metric, or american #`  
 `tz = # any entry from the Olson tz database e.g. America/Denver #`  
 `path = # the filesystem path to the Python program -- only applies when type is python #`  
-`wind_mode = # normal or average #`  
-`hn24 = # yes or no #`  
+`wind_mode = # normal or average -- only applies when type is mesowest #`  
+`hn24 = # true or false -- only applies when type is mesowest #`  
 
 `[infoex]`  
 `host = # InfoEx FTP host address #`  
@@ -280,6 +280,9 @@ and the conversion will take place through the MesoWest/Synoptic API.
 For NRCS, this program will do the conversion manually, as NRCS does not
 permit specifying the desired unit.
 
+There is an "American" units mode in which precip data is converted to
+metric, and wind data is converted to imperial units.
+
 A note on supported measurements
 --------------------------------
 
@@ -331,6 +334,30 @@ windGustSpeedNum
 Version history
 ---------------
 
+- 3.4.2 (Dec 2022)
+
+  Fix mm/cm bug with Mesowest stations in American units mode.
+
+- 3.4.1 (Dec 2022)
+
+  Reverse "American" units mode such that precip values are in metric,
+  and wind values are in imperial/English.
+
+- 3.4.0 (Mar 2022)
+
+  Implement HN24 for NRCS SNOTEL stations, and implement "American"
+  units mode.
+
+- 3.3.1 (Jan 2022)
+
+  Fix bug in which HN24 values under certain circumstances could be
+  inaccurate.
+
+- 3.3.0 (Nov 2021)
+
+  Implement wind averaging and auto-calculation of HN24. These are
+  opt-in via two new configuration options.
+
 - 3.2.4 (Mar 2021)
 
   Fix a small bug that allowed MesoWest HS values to flow through in