changeset 501:7c4cef80f826

weather: Add some comments to the example configuration.
author Matti Hamalainen <ccr@tnsp.org>
date Thu, 23 Jan 2020 06:14:06 +0200
parents f31cb0b7d0c0
children 1255d524a919
files config.weather.example
diffstat 1 files changed, 9 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/config.weather.example	Thu Jan 23 06:04:58 2020 +0200
+++ b/config.weather.example	Thu Jan 23 06:14:06 2020 +0200
@@ -37,6 +37,8 @@
 ###
 set weather_msg_list_station [list "\002@station@\002 ( http://www.google.fi/maps/@@c_lat@,@c_lng@,18z )"]
 
+
+# Array/list of wind directions (8 in total)
 set weather_msg_wind_directions [list]
 lappend weather_msg_wind_directions "pohjoinen (N)"
 lappend weather_msg_wind_directions "koillinen (NE)"
@@ -48,6 +50,8 @@
 lappend weather_msg_wind_directions "luode (NW)"
 
 
+# Array/list of FMI cloudiness value descriptions (9 total)
+# randing from "clear" to "fully cloudy"
 set weather_msg_cloudiness [list]
 lappend weather_msg_cloudiness "selkeää"
 lappend weather_msg_cloudiness "melkein selkeää"
@@ -60,6 +64,7 @@
 lappend weather_msg_cloudiness "pilvistä"
 
 
+# Array/list of Tiehallinto precipitation value descriptions
 set weather_msg_precipitation [list]
 lappend weather_msg_precipitation "poutaa"
 lappend weather_msg_precipitation ""
@@ -68,6 +73,10 @@
 lappend weather_msg_precipitation "heikkoa lumisadetta/räntää"
 
 
+# Array/list containing optional parts of the result message for one
+# one measurement station. Every array element except the first one
+# are optional and will only be appended to result string IF the
+# named @token@ value is "set" e.g. not empty or in some cases invalid.
 set weather_msg_result [list]
 lappend weather_msg_result "\002@station@\002, mitattu klo @ctime@: \002@temp@°C\002"
 lappend weather_msg_result ", tien pinta @road_surface_temp@°C"