X-Git-Url: https://wylark.com/src/infoex-autowx.git/blobdiff_plain/f41647a44c410ccf016776389d07b89d65519889..6980e4fef8dad4b47cb03b879860b5981c1e67cc:/README.md?ds=inline diff --git a/README.md b/README.md index 8dde3f0..beee3aa 100644 --- a/README.md +++ b/README.md @@ -52,20 +52,22 @@ created earlier): Configuration File ------------------ -The configuration file is separated into two parts, the -[nrcs]/[mesowest] portion, and the [infoex] portion. +The configuration file is separated into two parts, the [station] +portion, and the [infoex] portion. -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 [station] 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 weather station FTP server and other InfoEx-related configuration options. -`[nrcs]` -`station_triplet = [The NRCS identifier for a particular SNOTEL site]` -`desired_data = [A comma-delimited list of NRCS elements you're interested in]` +`[station]` +`type = [Either mesowest or nrcs]` +`token = [MesoWest API token -- ignored when type is nrcs]` +`station_id = [The NRCS/MesoWest identifier for a particular station]` +`desired_data = [A comma-delimited list of fields you're interested in]` `[infoex]` `host = [InfoEx FTP host address]` @@ -74,11 +76,12 @@ 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 values ------------------------- +Finding Your NRCS `station` values +---------------------------------- -To complete the [nrcs] configuration section, you must fill in the -attributes of the NRCS SNOTEL site from which you want to import data. +To complete the [station] configuration section for an NRCS station, 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: @@ -94,7 +97,7 @@ Here are the steps to do that: 4-digit number). 3. Combine your Station ID, state abbreviation, and the network type - "SNTL" to get your station triplet (`station_triplet`, in the + "SNTL" to get your NRCS station triplet (`station_id`, in the configuration file). For example: 655:OR:SNTL @@ -103,9 +106,9 @@ Here are the steps to do that: of Oregon (OR). SNTL just represents that the station is in the SNOTEL network and is used internally by NRCS. -Once you have your station triplet, fill in the field in your -configuration file. Now you must select which data you'd like to pull -from NRCS to push into InfoEx. +Once you have your station ID, fill in the field in your configuration +file. Now you must select which data you'd like to pull from NRCS to +push into InfoEx. For that, visit the NRCS web service: @@ -121,23 +124,23 @@ configuration file as the `desired_data` value. For example: -`station_triplet = 655:OR:SNTL` +`station_id = 655:OR:SNTL` `desired_data = TOBS,PREC` 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 ----------------------------- +Finding your MesoWest `station` 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: +To complete the [station] configuration section for a MesoWest station, +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