Get basic temperature, conditions, location working with scaled icon

Author: queenkjuul

src/util/location.py

@@ -0,0 +1,11 @@
+from dataclasses import dataclass
+from typing import NamedTuple, Optional
+
+@dataclass
+class LocationData:
+    lat: float
+    lon: float
+    city: Optional[str] = None
+    country: Optional[str] = None
+    timeZone: Optional[str] = None
+    entryText: Optional[str] = None

src/util/meson.build

@@ -4,9 +4,13 @@ app_py = [
   'fader.py',
   'focusNavigator.py',
   'keybindings.py',
+  'location.py',
+  'openweathermap.py',
   'settings.py',
   'trackers.py',
-  'utils.py'
+  'utils.py',
+  'weather.py',
+  'weather_types.py'
 ]
 
 install_data(app_py, install_dir: join_paths(pkgdatadir, 'util'))

src/util/openweathermap.py

@@ -0,0 +1,190 @@
+import json
+
+import requests
+from types import SimpleNamespace
+from gi.repository import Pango
+
+from util import settings
+from util.weather_types import APIUniqueField, BuiltinIcons, CustomIcons, Condition, Location, LocationData, WeatherData, WeatherProvider, Wind
+
+OWM_URL = "https://api.openweathermap.org/data/2.5/weather"
+OWM_SUPPORTED_LANGS = [
+    "af", "al", "ar", "az", "bg", "ca", "cz", "da", "de", "el", "en", "eu", "fa", "fi",
+    "fr", "gl", "he", "hi", "hr", "hu", "id", "it", "ja", "kr", "la", "lt", "mk", "no", "nl", "pl",
+    "pt", "pt_br", "ro", "ru", "se", "sk", "sl", "sp", "es", "sr", "th", "tr", "ua", "uk", "vi", "zh_cn", "zh_tw", "zu"
+]
+
+
+class OWMWeatherProvider(WeatherProvider):
+    """
+    WeatherProvider implementation for OpenWeatherMap.org
+    """
+
+    def __init__(self):
+        self.needsApiKey = False
+        self.prettyName = _("OpenWeatherMap")
+        self.name = "OpenWeatherMap_Open"
+        self.maxForecastSupport = 7
+        self.maxHourlyForecastSupport = 0
+        self.website = "https://openweathermap.org/"
+        self.remainingCalls = None
+        self.supportHourlyPrecipChance = False
+        self.supportHourlyPrecipVolume = False
+
+        # NOT SUPPORTED in cinnamon-spices-applets/weather
+        # but it saves us implementing conversion functions until we need them
+        # (which would be once we have more than just the one WeatherProvider)
+        self.units = settings.get_weather_units()
+
+    def GetWeather(self, loc: LocationData):
+        lang = self.locale_to_owm_lang(
+            Pango.language_get_default().to_string())
+        pref = Pango.language_get_preferred()
+        if lang not in OWM_SUPPORTED_LANGS:
+            for locale in pref:
+                if self.locale_to_owm_lang(locale) in OWM_SUPPORTED_LANGS:
+                    lang = self.locale_to_owm_lang(locale)
+                    break
+        # if we still have not found a supported language...
+        if lang not in OWM_SUPPORTED_LANGS:
+            lang = "en"
+
+        response = requests.get(OWM_URL,
+                                {
+                                    "lat": loc.lat,
+                                    "lon": loc.lon,
+                                    "units": self.units,
+                                    "appid": settings.get_weather_api_key(),
+                                    "lang": lang})
+
+        # actual object structure: https://github.com/linuxmint/cinnamon-spices-applets/weather@mockturtl/src/3_8/providers/openweathermap/payload/weather.ts
+        data = json.loads(
+            response.text, object_hook=lambda d: SimpleNamespace(**d))
+        print(data.name)
+        return self.owm_data_to_weather_data(data)
+
+    @staticmethod
+    def locale_to_owm_lang(locale_string):
+        if locale_string is None:
+            return "en"
+
+        # Dialect? support by OWM
+        if locale_string == "zh-cn" or locale_string == "zh-cn" or locale_string == "pt-br":
+            return locale_string
+
+        lang = locale_string.split("-")[0]
+        # OWM uses different language code for Swedish, Czech, Korean, Latvian, Norwegian
+        if lang == "sv":
+            return "se"
+        elif lang == "cs":
+            return "cz"
+        elif lang == "ko":
+            return "kr"
+        elif lang == "lv":
+            return "la"
+        elif lang == "nn" or lang == "nb":
+            return "no"
+        return lang
+
+    def owm_data_to_weather_data(self, owm_data) -> WeatherData:
+        """
+        Returns as much of a complete WeatherData object as we can
+        """
+        return WeatherData(**dict(
+            date=owm_data.dt,
+            sunrise=owm_data.sys.sunrise,
+            sunset=owm_data.sys.sunset,
+            coord=owm_data.coord,
+            location=Location(**dict(
+                city=owm_data.name,
+                country=owm_data.sys.country,
+                url="https://openweathermap.org/city/%s" % owm_data.id)),
+            condition=Condition(**dict(
+                main=owm_data.weather[0].main,
+                description=owm_data.weather[0].description,
+                icons=self.owm_icon_to_builtin_icons(owm_data.weather[0].icon),
+                customIcon=self.owm_icon_to_custom_icon(
+                    owm_data.weather[0].icon)
+            )),
+            wind=Wind(**dict(
+                speed=owm_data.wind.speed,
+                degree=owm_data.wind.deg
+            )),
+            temperature=owm_data.main.temp,
+            pressure=owm_data.main.pressure,
+            humidity=owm_data.main.humidity,
+            dewPoint=None,
+            extra_field=APIUniqueField(**dict(
+                type="temperature",
+                name=_("Feels Like"),
+                value=owm_data.main.feels_like
+            ))
+        ))
+
+    def owm_icon_to_builtin_icons(self, icon) -> list[BuiltinIcons]:
+        # https://openweathermap.org/weather-conditions
+        # fallback icons are: weather-clear-night
+        # weather-clear weather-few-clouds-night weather-few-clouds
+        # weather-fog weather-overcast weather-severe-alert weather-showers
+        # weather-showers-scattered weather-snow weather-storm
+        match icon:
+            case "10d":
+                # rain day */
+                return ["weather-rain", "weather-showers-scattered", "weather-freezing-rain"]
+            case "10n":
+                # rain night */
+                return ["weather-rain", "weather-showers-scattered", "weather-freezing-rain"]
+            case "09n":
+                # showers night*/
+                return ["weather-showers"]
+            case "09d":
+                # showers day */
+                return ["weather-showers"]
+            case "13d":
+                # snow day*/
+                return ["weather-snow"]
+            case "13n":
+                # snow night */
+                return ["weather-snow"]
+            case "50d":
+                # mist day */
+                return ["weather-fog"]
+            case "50n":
+                # mist night */
+                return ["weather-fog"]
+            case "04d":
+                # broken clouds day */
+                return ["weather-overcast", "weather-clouds", "weather-few-clouds"]
+            case "04n":
+                # broken clouds night */
+                return ["weather-overcast", "weather-clouds-night", "weather-few-clouds-night"]
+            case "03n":
+                # mostly cloudy (night) */
+                return ['weather-clouds-night', "weather-few-clouds-night"]
+            case "03d":
+                # mostly cloudy (day) */
+                return ["weather-clouds", "weather-few-clouds", "weather-overcast"]
+            case "02n":
+                # partly cloudy (night) */
+                return ["weather-few-clouds-night"]
+            case "02d":
+                # partly cloudy (day) */
+                return ["weather-few-clouds"]
+            case "01n":
+                # clear (night) */
+                return ["weather-clear-night"]
+            case "01d":
+                # sunny */
+                return ["weather-clear"]
+            case "11d":
+                # storm day */
+                return ["weather-storm"]
+            case "11n":
+                # storm night */
+                return ["weather-storm"]
+            case _:
+                return ["weather-severe-alert"]
+
+    @staticmethod
+    def owm_icon_to_custom_icon(icon) -> CustomIcons:
+        return None  # TODO

src/util/settings.py

@@ -51,7 +51,8 @@
 OSK_SIZE = "keyboard-size"
 OSK_ACTIVATION = "activation-mode"
 
-a11y_settings = Gio.Settings(schema_id="org.cinnamon.desktop.a11y.applications")
+a11y_settings = Gio.Settings(
+    schema_id="org.cinnamon.desktop.a11y.applications")
 OSK_A11Y_ENABLED = "screen-keyboard-enabled"
 
 # Every setting has a getter (and setter, rarely).  This is mainly for
@@ -60,119 +61,153 @@
 # "settings.ss_settings.get_string(settings.DEFAULT_MESSAGE_KEY)" or keeping
 # instances of GioSettings wherever we need them.
 
+
 def _check_string(string):
     if string and string != "":
         return string
 
     return ""
 
+
 def get_default_away_message():
     msg = ss_settings.get_string(DEFAULT_MESSAGE_KEY)
 
     return _check_string(msg)
 
+
 def get_custom_screensaver():
     cmd = ss_settings.get_string(CUSTOM_SCREENSAVER_KEY)
 
     return _check_string(cmd)
 
+
 def get_user_switch_enabled():
     return ss_settings.get_boolean(USER_SWITCH_ENABLED_KEY)
 
+
 def get_idle_activate():
     return ss_settings.get_boolean(IDLE_ACTIVATE_KEY)
 
+
 def get_idle_lock_enabled():
     return ss_settings.get_boolean(LOCK_ENABLED_KEY)
 
+
 def get_idle_lock_delay():
     return ss_settings.get_uint(LOCK_DELAY_KEY)
 
+
 def get_use_custom_format():
     return ss_settings.get_boolean(USE_CUSTOM_FORMAT_KEY)
 
+
 def get_custom_date_format():
     date_format = ss_settings.get_string(DATE_FORMAT_KEY)
 
     return _check_string(date_format)
 
+
 def get_custom_time_format():
     time_format = ss_settings.get_string(TIME_FORMAT_KEY)
 
     return _check_string(time_format)
 
+
 def get_date_font():
     date_font = ss_settings.get_string(FONT_DATE_KEY)
 
     return _check_string(date_font)
 
+
 def get_message_font():
     message_font = ss_settings.get_string(FONT_MESSAGE_KEY)
 
     return _check_string(message_font)
 
+
 def get_time_font():
     time_font = ss_settings.get_string(FONT_TIME_KEY)
 
     return _check_string(time_font)
 
+
 def get_show_flags():
     return if_settings.get_boolean(KBD_LAYOUT_SHOW_FLAGS)
 
+
 def get_show_upper_case_layout():
     return if_settings.get_boolean(KBD_LAYOUT_USE_CAPS)
 
+
 def get_use_layout_variant_names():
     return if_settings.get_boolean(KBD_LAYOUT_PREFER_VARIANT)
 
+
 def get_kb_group():
     return ss_settings.get_int(KB_LAYOUT_KEY)
 
+
 def set_kb_group(group):
     return ss_settings.set_int(KB_LAYOUT_KEY, group)
 
+
 def get_show_clock():
     return ss_settings.get_boolean(SHOW_CLOCK_KEY)
 
+
 def get_show_albumart():
     return ss_settings.get_boolean(SHOW_ALBUMART)
 
+
 def get_show_weather():
     # return ss_settings.get_boolean(SHOW_WEATHER)
     return True
 
+
 def get_weather_api_key():
     # return ss_settings.get_string(WEATHER_API_KEY)
-    return ""
+    # this is the OpenWeatherMap API key used by linux-mint/cinnamon-spices-applets/weather@mockturtl
+    # presumably belongs to the org?
+    return "1c73f8259a86c6fd43c7163b543c8640"
+
 
 def get_weather_location():
-    # return ss_settings.get_string(WEAThER_LOCATION)   # string LAT,LON (eventually)
-    return "chicago,il,us"
+    # location_string = ss_settings.get_string(WEATHER_LOCATION)   # string LAT,LON (eventually)
+    # return _check_string(location_string)
+    return "41.85,-87.65"  # chicago,il,us
+
 
 def get_weather_units():
     # return ss_settings.get_string(WEATHER_UNITS)  # metric || imperial
     return "imperial"
 
+
 def get_weather_font():
     # reusing the Clock widget Time font for now (it's big)
     time_font = ss_settings.get_string(FONT_TIME_KEY)
 
     return _check_string(time_font)
 
+
 def get_allow_shortcuts():
     return ss_settings.get_boolean(ALLOW_SHORTCUTS)
 
+
 def get_allow_media_control():
     return ss_settings.get_boolean(ALLOW_MEDIA_CONTROL)
 
+
 def get_show_info_panel():
     return ss_settings.get_boolean(SHOW_INFO_PANEL)
 
+
 def get_allow_floating():
     return ss_settings.get_boolean(FLOATING_WIDGETS)
 
+
 def get_osk_type():
     return osk_settings.get_string(OSK_TYPE)
 
+
 def get_osk_a11y_active():
-    return a11y_settings.get_boolean(OSK_A11Y_ENABLED) and osk_settings.get_string(OSK_ACTIVATION) == 'accessible'
+    return a11y_settings.get_boolean(OSK_A11Y_ENABLED) and osk_settings.get_string(OSK_ACTIVATION) == 'accessible'

src/util/weather.py

@@ -0,0 +1,6 @@
+def k_to_f(k: float) -> int:
+    return round(k - 273.15)
+
+
+def k_to_c(k: float) -> float:
+    return round((9 / 5 * (k - 273.15) + 32), 1)