Bump version

[infoex-autowx.git] / README.md

diff --git a/README.md b/README.md
index 54d92b6387f1cd22ea87f37e6190de535f242968..c7f34c90a5f6ba476840e59d217b95e6a29844c4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -85,6 +85,8 @@ options.
 `units = # either english or metric -- only applies when type is mesowest #`  
 `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 #`  
 
 `[infoex]`  
 `host = # InfoEx FTP host address #`  
@@ -193,6 +195,40 @@ indicates that I'd like to import "Temperature" and "Precipitation
 accumulated" from the MesoWest station at Santiam Pass, OR, into InfoEx,
 and that I want that data in imperial units.
 
+Three- versus 24-hour ranges
+----------------------------
+
+By default, this program will fetch three hours of data from the
+provider. This way, if the most recent record has any missing data, it
+can examine the two hours prior, using whatever data it can find.
+
+There are two features which will cause the program to expand the time
+range of fetched data from three to 24 hours. Please be aware of this
+expansion as it may cause a rise in data/API usage.
+
+**NOTE: Only MesoWest stations have the benefit of wind averaging and
+        HN24 calculation at this time, because generally NRCS SNOTEL
+               stations do not provide wind data. HN24 support for NRCS SNOTEL
+               is planned.
+
+### Wind mode
+If you go to submit a Wx observation in InfoEx at e.g. 05:05, and have
+so configured InfoEx, it will take the wind speed, wind gust speed, and
+wind direction, from that hour and auto-fill it for the observation.
+
+Some operations may find it more important to know the averages for
+those values over the prior 24 hour period. Setting `wind_mode` to
+`average` will enable that.
+
+### HN24
+As most stations do not provide HN24 on their own, this program provides
+a configuration option for calculating this. Simply add `hn24 = true` to
+the configuration file.
+
+*NOTE: This is its own configuration option, rather than a new value for
+          desired_data, because it's not technically provided by MesoWest
+          or NRCS SNOTEL.*
+
 Custom weather station support
 ------------------------------
 
@@ -295,6 +331,11 @@ windGustSpeedNum
 Version history
 ---------------
 
+- 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