X-Git-Url: https://wylark.com/src/infoex-autowx.git/blobdiff_plain/5a530e493591e037478751bf4c54f1e6b28aa737..1a0db30b2b4d47b236876265832491dbf9cffae0:/README.md?ds=sidebyside diff --git a/README.md b/README.md index 1de071b..4a24833 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,18 @@ InfoEx AutoWx (IEAW) ============= -This program fetches data from an NRCS SNOTEL site 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 and +pushes it into the InfoEx system using the new automated weather system +implementation. -License under the MIT license (see file: LICENSE). +License under the ISC license (see file: LICENSE). Disclaimer ---------- -Your usage of the NRCS and InfoEx systems is bound by their respective -terms and this software makes no attempt or claim to abide by any such -terms. +Your usage of the NRCS, MesoWest, and/or InfoEx systems is bound by +their respective terms and this software makes no attempt or claim to +abide by any such terms. Installation ------------ @@ -31,8 +32,8 @@ This program is designed to be run from the command line (or via cron(8)) and administered via a simple, concise configuration file. This design allows you to run a separate program instance for each NRCS -weather station from which you'd like to automate the importation of -data into your InfoEx subscriber account. +or MesoWest weather station from which you'd like to automate the +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): @@ -77,7 +78,7 @@ options. `csv_filename = # arbitrary name of the file that will be uploaded to InfoEx #` `location_uuid = # the UUID used by InfoEx to identify your automated Wx site #` -Finding Your NRCS `station` values +Finding your NRCS `station` values ---------------------------------- To complete the [station] configuration section for an NRCS station, you @@ -169,7 +170,7 @@ A complete example: `[station]` `type = mesowest` `token = # token id copied from MesoWest web account #` -`stid = OD110` +`station_id = OD110` `desired_data = air_temp,snow_depth` `units = english` @@ -177,7 +178,32 @@ 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. -Version History +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: + +precipitationGauge +tempPres +hS +baro +rH +windSpeedNum +windDirectionNum +windGustSpeedNum (only supported by MesoWest) + +Version history --------------- - 2.0.0 (Jul 2020)