X-Git-Url: https://wylark.com/src/infoex-autowx.git/blobdiff_plain/638c4f11d29b685bc7c485c10ce62f2c61ae4a54..2034a5a98fec948aff0f8556246f83d38abc0f89:/README.md?ds=sidebyside

diff --git a/README.md b/README.md
index 8bbe60e..944606c 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,9 @@
 InfoEx AutoWx (IEAW)
 =============
 
-This program fetches data from an NRCS SNOTEL or MesoWest station and
-pushes it into the InfoEx system using the new automated weather system
-implementation.
+This program fetches data from an NRCS SNOTEL or MesoWest station, or
+your own custom data source, and pushes it into the InfoEx system using
+the new automated weather system implementation.
 
 Licensed under the ISC license (see file: LICENSE).
 
@@ -199,6 +199,13 @@ This program supports custom weather station data by allowing the user
 to specify the path to an external Python program. The external Python
 program should emit its data in the form expected by infoex-autowx.
 
+This is a powerful feature which enables the user to upload data from
+any source imaginable into InfoEx. Common examples are a local database
+or a remote web page which requires some custom parsing.
+
+Please see the program located at examples/custom-wx.example.py for a
+complete description of what's required.
+
 A note on supported measurements
 --------------------------------
 
@@ -208,7 +215,6 @@ weather station may not record them. In this case, the data will simply
 be ignored (i.e. it will NOT log "0" when there's no measurement
 available).
 
-
 InfoEx provides a mechanism for inspecting your automated weather
 station data, so use that after setting this program up and compare it
 with the data you see in your web browser.
@@ -234,15 +240,50 @@ wind\_speed
 wind\_direction  
 wind\_gust  
 
+**Custom Wx program**  
+*infoex-autowx expects a custom Wx data provider to provide at least one
+of the following:*  
+precipitationGauge  
+tempPres  
+tempMaxHour  
+tempMinHour  
+hS  
+baro  
+rH  
+windSpeedNum  
+windDirectionNum  
+windGustSpeedNum  
+
 Future plans
 ------------
 
-- Improve the documentation
 - Implement unit conversion for NRCS stations
 
 Version history
 ---------------
 
+- 3.0.1 (Jan 2021)
+
+  General fixes.
+
+  - MesoWest wind data (speed and gust speed) units are now transformed
+    from their origin unit (meters per second) to the unit expected by
+    InfoEx (miles per hour).
+
+  - Relative humidity is now rounded to one decimal place, preventing
+    InfoEx from reddening the auto-filled value.
+
+- 3.0.0 (Nov 2020)
+
+  Implement Custom Wx data providers.
+
+  This release enables the user to write their own Python programs and
+  specify them to infoex-autowx as a data provider.
+
+  This in turn enables the user to pull data from e.g. a local database
+  or an HTML page and push it into their InfoEx auto station data,
+  limited only by the imagination.
+
 - 2.2.0 (Nov 2020)
 
   Add support for Tmin/Tmax values (directly from MesoWest/NRCS).