Add examples/ dir and add a custom Wx example

[infoex-autowx.git] / README.md

diff --git a/README.md b/README.md
index 96a530a48092fda30a9c1806d644d09715812ea5..8bbe60e022b00e9286ad87910cc2a3f824c442cd 100644 (file)
--- a/README.md
+++ b/README.md
@@ -78,11 +78,12 @@ weather station FTP server and other InfoEx-related configuration
 options.
 
 `[station]`  
 options.
 
 `[station]`  

-`type = # either mesowest or nrcs #`  
-`token = # MesoWest API token -- ignored when type is nrcs #`  
+`type = # mesowest, nrcs, or python #`  
+`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 #`  
 `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 -- ignored when type is nrcs #`  
+`units = # either english or metric -- only applies when type is mesowest #`  
+`path = # the filesystem path to the Python program -- only applies when type is python #`  

 
 `[infoex]`  
 `host = # InfoEx FTP host address #`  
 
 `[infoex]`  
 `host = # InfoEx FTP host address #`  


@@ -191,6 +192,13 @@ 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.
 
 accumulated" from the MesoWest station at Santiam Pass, OR, into InfoEx,
 and that I want that data in imperial units.
 

+Custom weather station support
+------------------------------
+
+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.
+

 A note on supported measurements
 --------------------------------
 
 A note on supported measurements
 --------------------------------
 


@@ -235,6 +243,14 @@ Future plans
 Version history
 ---------------
 
 Version history
 ---------------
 

+- 2.2.0 (Nov 2020)
+
+  Add support for Tmin/Tmax values (directly from MesoWest/NRCS).
+
+- 2.1.0 (Nov 2020)
+
+  Adjust precision of certain values before sending them to InfoEx.
+

 - 2.0.2 (Jul 2020)
 
   Fix issues shown by pylint(1).
 - 2.0.2 (Jul 2020)
 
   Fix issues shown by pylint(1).