X-Git-Url: https://wylark.com/src/infoex-autowx.git/blobdiff_plain/87dfcd0c29eb8e8f4ea455449d173e1eecb16922..f41647a44c410ccf016776389d07b89d65519889:/README.md diff --git a/README.md b/README.md index 3a3a29f..8dde3f0 100644 --- a/README.md +++ b/README.md @@ -55,8 +55,8 @@ Configuration File The configuration file is separated into two parts, the [nrcs]/[mesowest] portion, and the [infoex] portion. -The [nrcs]/[mesowest] values describe which NRCS SNOTEL site's data -you're after. See the next section in this README for instructions on +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 [infoex] values describe your credentials for the InfoEx automated @@ -131,13 +131,25 @@ 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. +data. Here are the steps to do that: -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: -Field names are listed here: https://developers.synopticdata.com/about/station-variables/ The MesoWest API supports on-the-fly unit conversion, so that can be @@ -145,6 +157,17 @@ 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 ---------------