Document new --log-level switch

[infoex-autowx.git] / README.md

diff --git a/README.md b/README.md
index e4502750d602210db93af5512da6b79e43d87842..cda54b9a118d86ef34b4cfc0611209e3fe6df0d5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -38,11 +38,16 @@ importation of data into your InfoEx subscriber account.
 To run ad-hoc (be sure to activate the virtual environment, as detailed in the
 Installation section):
 
 To run ad-hoc (be sure to activate the virtual environment, as detailed in the
 Installation section):
 

-`./infoex-autowx.py --config [path/to/config-file.ini] [--dry-run]`
+`./infoex-autowx.py --config path/to/config-file.ini [--dry-run] [--log-level debug|info|warning]`

 
 **NOTE: Specifying --dry-run will also not clean up the generated CSV
 file.** This is so that you can debug any issues more easily.
 
 
 **NOTE: Specifying --dry-run will also not clean up the generated CSV
 file.** This is so that you can debug any issues more easily.
 

+You can also specify `--log-level` as debug, info, warning. The
+resultant log messages will try to be logged to journald, but if that's
+not available, they will be printed to stdout. This output can be
+helpful early on in the setup process.
+

 Here's an example of a crontab(5) with two SNOTEL sites, each of which
 will run once per hour (note that this will activate the virtual environment
 created earlier):
 Here's an example of a crontab(5) with two SNOTEL sites, each of which
 will run once per hour (note that this will activate the virtual environment
 created earlier):


@@ -178,6 +183,47 @@ 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.
 

+A note on supported measurements
+--------------------------------
+
+While this program supports several measurements, and will faithfully
+request all of the ones you specify (provided they're supported), the
+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.
+
+Here's the list of measurements currently supported:
+
+**NRCS:**  
+PREC  
+TOBS  
+SNWD  
+PRES  
+RHUM  
+WSPD  
+WDIR  
+
+**MesoWest:**  
+precip\_accum  
+air\_temp  
+snow\_depth  
+pressure  
+relative\_humidity  
+wind\_speed  
+wind\_direction  
+wind\_gust  
+
+Future plans
+------------
+
+- Improve the documentation
+- Implement unit conversion for NRCS stations
+

 Version history
 ---------------
 
 Version history
 ---------------