annotate config.fetch_weather.example @ 698:6ba9f961e463 default tip

quotedb: Bump version and copyright.
author Matti Hamalainen <ccr@tnsp.org>
date Mon, 18 Sep 2023 11:38:41 +0300
parents c95c0eb0a10f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
187
8b0a9315c69e Permissions.
Matti Hamalainen <ccr@tnsp.org>
parents: 186
diff changeset
1 ###
188
1487659d4f26 Typofix.
Matti Hamalainen <ccr@tnsp.org>
parents: 187
diff changeset
2 ### Example configuration for weather.tcl data fetcher
1487659d4f26 Typofix.
Matti Hamalainen <ccr@tnsp.org>
parents: 187
diff changeset
3 ### script fetch_weather.pl.
187
8b0a9315c69e Permissions.
Matti Hamalainen <ccr@tnsp.org>
parents: 186
diff changeset
4 ###
494
3cf06dfc7ba8 fetch_weather: Add a note in the example configuration about the
Matti Hamalainen <ccr@tnsp.org>
parents: 486
diff changeset
5 # NOTE! There are some undocumented settings too,
3cf06dfc7ba8 fetch_weather: Add a note in the example configuration about the
Matti Hamalainen <ccr@tnsp.org>
parents: 486
diff changeset
6 # take a look at the %settings hash in the script.
3cf06dfc7ba8 fetch_weather: Add a note in the example configuration about the
Matti Hamalainen <ccr@tnsp.org>
parents: 486
diff changeset
7
187
8b0a9315c69e Permissions.
Matti Hamalainen <ccr@tnsp.org>
parents: 186
diff changeset
8
8b0a9315c69e Permissions.
Matti Hamalainen <ccr@tnsp.org>
parents: 186
diff changeset
9 ##
373
bc7746ca622e fetch_weather: Implement purge_threshold setting.
Matti Hamalainen <ccr@tnsp.org>
parents: 348
diff changeset
10 ## Purge time threshold for old/obsolete records.
bc7746ca622e fetch_weather: Implement purge_threshold setting.
Matti Hamalainen <ccr@tnsp.org>
parents: 348
diff changeset
11 ## Fetch_weather stores data into a cache file, which
bc7746ca622e fetch_weather: Implement purge_threshold setting.
Matti Hamalainen <ccr@tnsp.org>
parents: 348
diff changeset
12 ## also keeps older records as sometimes weather stations
bc7746ca622e fetch_weather: Implement purge_threshold setting.
Matti Hamalainen <ccr@tnsp.org>
parents: 348
diff changeset
13 ## do not report reliably. However, too old records
bc7746ca622e fetch_weather: Implement purge_threshold setting.
Matti Hamalainen <ccr@tnsp.org>
parents: 348
diff changeset
14 ## need to be purged. This setting sets the threshold
bc7746ca622e fetch_weather: Implement purge_threshold setting.
Matti Hamalainen <ccr@tnsp.org>
parents: 348
diff changeset
15 ## time in MINUTES (default is 60 minutes)
bc7746ca622e fetch_weather: Implement purge_threshold setting.
Matti Hamalainen <ccr@tnsp.org>
parents: 348
diff changeset
16 ##
bc7746ca622e fetch_weather: Implement purge_threshold setting.
Matti Hamalainen <ccr@tnsp.org>
parents: 348
diff changeset
17 purge_threshold = 60
bc7746ca622e fetch_weather: Implement purge_threshold setting.
Matti Hamalainen <ccr@tnsp.org>
parents: 348
diff changeset
18
bc7746ca622e fetch_weather: Implement purge_threshold setting.
Matti Hamalainen <ccr@tnsp.org>
parents: 348
diff changeset
19
bc7746ca622e fetch_weather: Implement purge_threshold setting.
Matti Hamalainen <ccr@tnsp.org>
parents: 348
diff changeset
20 ##
187
8b0a9315c69e Permissions.
Matti Hamalainen <ccr@tnsp.org>
parents: 186
diff changeset
21 ## Enable/disable data scraping from Tiehallinto's WWW-pages
8b0a9315c69e Permissions.
Matti Hamalainen <ccr@tnsp.org>
parents: 186
diff changeset
22 ##
8b0a9315c69e Permissions.
Matti Hamalainen <ccr@tnsp.org>
parents: 186
diff changeset
23 opt_tiehallinto = 1
8b0a9315c69e Permissions.
Matti Hamalainen <ccr@tnsp.org>
parents: 186
diff changeset
24
348
9f64f54c2fb3 Update example configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 275
diff changeset
25 ## Tiehallinto static meta data file + path
446
ba559d5d44db fetch_weather: Rename the Tiehallinto static metadata cache filename setting.
Matti Hamalainen <ccr@tnsp.org>
parents: 373
diff changeset
26 tiehallinto_meta = "/some/path/weather.tiehallinto.meta"
348
9f64f54c2fb3 Update example configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 275
diff changeset
27
447
11124f9bf994 fetch_weather: Instead of checking the latest static metadata update timestamp against the weather data XML, have a setting of days until the metadata is considered stale.
Matti Hamalainen <ccr@tnsp.org>
parents: 446
diff changeset
28 # Fetch period for static meta data (in days)
11124f9bf994 fetch_weather: Instead of checking the latest static metadata update timestamp against the weather data XML, have a setting of days until the metadata is considered stale.
Matti Hamalainen <ccr@tnsp.org>
parents: 446
diff changeset
29 tiehallinto_meta_period = 7
11124f9bf994 fetch_weather: Instead of checking the latest static metadata update timestamp against the weather data XML, have a setting of days until the metadata is considered stale.
Matti Hamalainen <ccr@tnsp.org>
parents: 446
diff changeset
30
187
8b0a9315c69e Permissions.
Matti Hamalainen <ccr@tnsp.org>
parents: 186
diff changeset
31 ##
8b0a9315c69e Permissions.
Matti Hamalainen <ccr@tnsp.org>
parents: 186
diff changeset
32 ## Enable/disable open data access from FMI
8b0a9315c69e Permissions.
Matti Hamalainen <ccr@tnsp.org>
parents: 186
diff changeset
33 ##
486
b352722e8717 fetch_weather: FMI open data no longer requires an API key. Also the data
Matti Hamalainen <ccr@tnsp.org>
parents: 447
diff changeset
34 opt_fmi = 1
187
8b0a9315c69e Permissions.
Matti Hamalainen <ccr@tnsp.org>
parents: 186
diff changeset
35
8b0a9315c69e Permissions.
Matti Hamalainen <ccr@tnsp.org>
parents: 186
diff changeset
36 ##
8b0a9315c69e Permissions.
Matti Hamalainen <ccr@tnsp.org>
parents: 186
diff changeset
37 ## Debug mode, outputs some stuff sometimes maybe
8b0a9315c69e Permissions.
Matti Hamalainen <ccr@tnsp.org>
parents: 186
diff changeset
38 ##
679
c95c0eb0a10f fetch_weather: Disable debug from example config.
Matti Hamalainen <ccr@tnsp.org>
parents: 494
diff changeset
39 #debug = 1
187
8b0a9315c69e Permissions.
Matti Hamalainen <ccr@tnsp.org>
parents: 186
diff changeset
40
8b0a9315c69e Permissions.
Matti Hamalainen <ccr@tnsp.org>
parents: 186
diff changeset
41 ##
8b0a9315c69e Permissions.
Matti Hamalainen <ccr@tnsp.org>
parents: 186
diff changeset
42 ## Path to the output file, should be same as set in weather.tcl
8b0a9315c69e Permissions.
Matti Hamalainen <ccr@tnsp.org>
parents: 186
diff changeset
43 ## If NOT set, the script will output to stdout.
8b0a9315c69e Permissions.
Matti Hamalainen <ccr@tnsp.org>
parents: 186
diff changeset
44 ##
348
9f64f54c2fb3 Update example configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 275
diff changeset
45 outfile = "/some/path/weather.data"
187
8b0a9315c69e Permissions.
Matti Hamalainen <ccr@tnsp.org>
parents: 186
diff changeset
46
8b0a9315c69e Permissions.
Matti Hamalainen <ccr@tnsp.org>
parents: 186
diff changeset
47 ##
8b0a9315c69e Permissions.
Matti Hamalainen <ccr@tnsp.org>
parents: 186
diff changeset
48 ## HTTP user agent. If not set here, default will be used.
8b0a9315c69e Permissions.
Matti Hamalainen <ccr@tnsp.org>
parents: 186
diff changeset
49 ##
8b0a9315c69e Permissions.
Matti Hamalainen <ccr@tnsp.org>
parents: 186
diff changeset
50 #http_user_agent = "Mozilla/5.0 (foobar)"