From 46e1fad742cdee58ef7aa9e1c523ef6883409977 Mon Sep 17 00:00:00 2001 From: Arsen Musayelyan Date: Tue, 22 Feb 2022 12:26:48 -0800 Subject: [PATCH] Add weather section to configuration page --- content/configuration/sections.md | 16 +++++++++++++++- content/getting-started/features.md | 4 ++++ 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/content/configuration/sections.md b/content/configuration/sections.md index b594ef2..0202ddf 100644 --- a/content/configuration/sections.md +++ b/content/configuration/sections.md @@ -119,4 +119,18 @@ This section contains options for music control #### vol.interval -This field is an integer indicating how much the volume should be changed for each volume up or down event from the music control app. \ No newline at end of file +This field is an integer indicating how much the volume should be changed for each volume up or down event from the music control app. + +--- + +### weather + +This section contains options for ITD's weather support + +#### weather.enabled + +This field is a boolean indicating whether the weather support should be enabled. + +#### weather.location + +This field is a string. It is given to OpenStreetMap Nominatim to retrieve coordinates to feed into the Norwegian Meteorological Institute's API. Anything that can be found on OpenStreetMap should also work here. It will always use the first result. \ No newline at end of file diff --git a/content/getting-started/features.md b/content/getting-started/features.md index 5c84d0a..932f85b 100644 --- a/content/getting-started/features.md +++ b/content/getting-started/features.md @@ -31,6 +31,10 @@ Music control is implemented using `playerctl` which uses the MPRIS DBus interfa ITD exposes a UNIX socket at `/tmp/itd/socket` by default. This socket can be used to control the daemon. It is how `itctl` and `itgui` work. This can be used in any language which supports UNIX sockets which is nearly all of them. Even bash can be used with `netcat`. +### Weather + +ITD uses data from OpenStreetMap Nominatim to get coordinates for a location, and then feeds those to the Norwegian Meteorological Institute's API to retrieve weather for that location. + ### New Features New features are added whenever I find out they exist from InfiniTime's repo or developers. This means ITD's master branch may contain features not yet released in InfiniTime. \ No newline at end of file