X-Git-Url: https://wylark.com/src/infoex-autowx.git/blobdiff_plain/5bb081b14946754f13e282055b90adee89ff29c0..7f4b193a6a5fbb1d209c5de542a47db2c3b36ba2:/README.md?ds=sidebyside

diff --git a/README.md b/README.md
index 1a5cbef..95f051e 100644
--- 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,35 @@ 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.
+
+### 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
 ------------------------------
 
@@ -233,6 +264,17 @@ which makes it into your operation is inaccurate, start your
 investigation with time zone-related issues and move on only once you've
 ruled this out as a cause of the inaccuracy.
 
+Unit conversions
+----------------
+
+Desired units may be specified in the configuration file.
+
+For MesoWest, the desired unit will be passed along in the API request
+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.
+
 A note on supported measurements
 --------------------------------
 
@@ -281,14 +323,40 @@ windSpeedNum
 windDirectionNum  
 windGustSpeedNum  
 
-Future plans
-------------
-
-- Implement unit conversion for NRCS stations
-
 Version history
 ---------------
 
+- 3.2.4 (Mar 2021)
+
+  Fix a small bug that allowed MesoWest HS values to flow through in
+  millimeters when metric was the specified unit. MesoWest metric HS
+  values are now correctly in centimeters.
+
+- 3.2.3 (Feb 2021)
+
+  Fix a small bug that allowed a TypeError to be raised with some
+  regularity.
+
+- 3.2.2 (Feb 2021)
+
+  Various small fixes.
+
+  - Round precipitation accumulation values to 2 decimal places.
+  - Catch requests' ConnectionException.
+  - Improve logging output when using stdout.
+
+- 3.2.1 (Feb 2021)
+
+  Fix config validation bug with units and custom Python program.
+
+- 3.2.0 (Feb 2021)
+
+  Implement NRCS unit conversion.
+
+- 3.1.1 (Feb 2021)
+
+  Fix relative humidity rounding.
+
 - 3.1.0 (Jan 2021)
 
   Implement time zone support.