X-Git-Url: https://wylark.com/src/infoex-autowx.git/blobdiff_plain/4b17ea1660c78d5b48295e805eead92f8da6ffe6..84825250e7444525d23fd81fe95a074483fa176d:/README.md?ds=sidebyside diff --git a/README.md b/README.md index 59b8a9a..8dde3f0 100644 --- a/README.md +++ b/README.md @@ -52,15 +52,16 @@ created earlier): Configuration File ------------------ -The configuration file is separated into two parts, the [wxsite] -portion, and the [ftp] portion. +The configuration file is separated into two parts, the +[nrcs]/[mesowest] portion, and the [infoex] portion. -The [wxsite] values describe which NRCS SNOTEL site's data you're after. -See the next section in this README for instructions on obtaining these -values. +The [nrcs]/[mesowest] values describe which weather station's data +you're after. See the next section in this README for instructions on +obtaining these values. -The [ftp] values describe your credentials for the InfoEx automated -weather station FTP server. +The [infoex] values describe your credentials for the InfoEx automated +weather station FTP server and other InfoEx-related configuration +options. `[nrcs]` `station_triplet = [The NRCS identifier for a particular SNOTEL site]` @@ -73,11 +74,12 @@ weather station FTP server. `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 WXSITE values --------------------------- +Finding Your NRCS values +------------------------ -To complete the [wxsite] configuration section, you must fill in the +To complete the [nrcs] configuration section, you must fill in the attributes of the NRCS SNOTEL site from which you want to import data. + Here are the steps to do that: 1. Find your station by clicking through this website: @@ -126,6 +128,46 @@ indicates that I'd like to import "AIR TEMPERATURE OBSERVED" and "PRECIPITATION ACCUMULATION" from the NRCS SNOTEL site at Mud Ridge, OR, into InfoEx. +Finding your MesoWest values +---------------------------- + +MesoWest has great documentation which can be found here: + +https://developers.synopticdata.com/mesonet/v2/getting-started/ + +To complete the [mesowest] configuration section, you must fill in the +attributes of the MesoWest station ID from which you want to import +data. Here are the steps to do that: + +1. Firstly, get set up with MesoWest's API by going to the above + 'Getting Started' link. Once you're set up, you can copy a token from + the MesoWest web portal into your configuration file's `token` value. + +2. Next, you will want to find the Station ID for the MesoWest weather + station of interest and copy it to the `stid` value. + +3. Finally, you must choose what data types you want to push into + InfoEx. MesoWest refers to these as 'field names' and a list is + available here: + +https://developers.synopticdata.com/about/station-variables/ + +The MesoWest API supports on-the-fly unit conversion, so that can be +specified to infoex-autowx via the configuration option `units`. This +can be either 'english' or 'metric', with 'english' meaning imperial +units as used in the United States. + +For example: + +`token = (token id)` +`stid = OD110` +`desired_data = air_temp,snow_depth` +`units = english` + +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 ---------------